# Leaked Credentials ## Get HTTP authentication requests distribution by dimension `client.Radar.LeakedCredentials.SummaryV2(ctx, dimension, query) (*LeakedCredentialSummaryV2Response, error)` **get** `/radar/leaked_credential_checks/summary/{dimension}` Retrieves an aggregated summary of HTTP authentication requests grouped by the specified dimension. ### Parameters - `dimension LeakedCredentialSummaryV2ParamsDimension` Specifies the attribute by which to group the results. - `const LeakedCredentialSummaryV2ParamsDimensionCompromised LeakedCredentialSummaryV2ParamsDimension = "COMPROMISED"` - `const LeakedCredentialSummaryV2ParamsDimensionBotClass LeakedCredentialSummaryV2ParamsDimension = "BOT_CLASS"` - `query LeakedCredentialSummaryV2Params` - `ASN param.Field[[]string]` Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. - `BotClass param.Field[[]LeakedCredentialSummaryV2ParamsBotClass]` Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - `const LeakedCredentialSummaryV2ParamsBotClassLikelyAutomated LeakedCredentialSummaryV2ParamsBotClass = "LIKELY_AUTOMATED"` - `const LeakedCredentialSummaryV2ParamsBotClassLikelyHuman LeakedCredentialSummaryV2ParamsBotClass = "LIKELY_HUMAN"` - `Compromised param.Field[[]LeakedCredentialSummaryV2ParamsCompromised]` Filters results by compromised credential status (clean vs. compromised). - `const LeakedCredentialSummaryV2ParamsCompromisedClean LeakedCredentialSummaryV2ParamsCompromised = "CLEAN"` - `const LeakedCredentialSummaryV2ParamsCompromisedCompromised LeakedCredentialSummaryV2ParamsCompromised = "COMPROMISED"` - `Continent param.Field[[]string]` Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialSummaryV2ParamsFormat]` Format in which results will be returned. - `const LeakedCredentialSummaryV2ParamsFormatJson LeakedCredentialSummaryV2ParamsFormat = "JSON"` - `const LeakedCredentialSummaryV2ParamsFormatCsv LeakedCredentialSummaryV2ParamsFormat = "CSV"` - `LimitPerGroup param.Field[int64]` Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. - `Location param.Field[[]string]` Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. - `Name param.Field[[]string]` Array of names used to label the series in the response. ### Returns - `type LeakedCredentialSummaryV2Response struct{…}` - `Meta LeakedCredentialSummaryV2ResponseMeta` Metadata for the results. - `ConfidenceInfo LeakedCredentialSummaryV2ResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialSummaryV2ResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialSummaryV2ResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialSummaryV2ResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialSummaryV2ResponseMetaNormalizationPercentage LeakedCredentialSummaryV2ResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationMin0Max LeakedCredentialSummaryV2ResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationMinMax LeakedCredentialSummaryV2ResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationRawValues LeakedCredentialSummaryV2ResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationPercentageChange LeakedCredentialSummaryV2ResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationRollingAverage LeakedCredentialSummaryV2ResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationOverlappedPercentage LeakedCredentialSummaryV2ResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialSummaryV2ResponseMetaNormalizationRatio LeakedCredentialSummaryV2ResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialSummaryV2ResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Summary0 map[string, string]` ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.SummaryV2( context.TODO(), radar.LeakedCredentialSummaryV2ParamsDimensionCompromised, radar.LeakedCredentialSummaryV2Params{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "summary_0": { "CLEAN": "85.123456", "COMPROMISED": "14.876544" } }, "success": true } ``` ## Get time series distribution of HTTP authentication requests by dimension. `client.Radar.LeakedCredentials.TimeseriesGroupsV2(ctx, dimension, query) (*LeakedCredentialTimeseriesGroupsV2Response, error)` **get** `/radar/leaked_credential_checks/timeseries_groups/{dimension}` Retrieves the distribution of HTTP authentication requests, grouped by the specified dimension over time. ### Parameters - `dimension LeakedCredentialTimeseriesGroupsV2ParamsDimension` Specifies the attribute by which to group the results. - `const LeakedCredentialTimeseriesGroupsV2ParamsDimensionCompromised LeakedCredentialTimeseriesGroupsV2ParamsDimension = "COMPROMISED"` - `const LeakedCredentialTimeseriesGroupsV2ParamsDimensionBotClass LeakedCredentialTimeseriesGroupsV2ParamsDimension = "BOT_CLASS"` - `query LeakedCredentialTimeseriesGroupsV2Params` - `AggInterval param.Field[LeakedCredentialTimeseriesGroupsV2ParamsAggInterval]` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupsV2ParamsAggInterval15m LeakedCredentialTimeseriesGroupsV2ParamsAggInterval = "15m"` - `const LeakedCredentialTimeseriesGroupsV2ParamsAggInterval1h LeakedCredentialTimeseriesGroupsV2ParamsAggInterval = "1h"` - `const LeakedCredentialTimeseriesGroupsV2ParamsAggInterval1d LeakedCredentialTimeseriesGroupsV2ParamsAggInterval = "1d"` - `const LeakedCredentialTimeseriesGroupsV2ParamsAggInterval1w LeakedCredentialTimeseriesGroupsV2ParamsAggInterval = "1w"` - `ASN param.Field[[]string]` Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. - `BotClass param.Field[[]LeakedCredentialTimeseriesGroupsV2ParamsBotClass]` Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - `const LeakedCredentialTimeseriesGroupsV2ParamsBotClassLikelyAutomated LeakedCredentialTimeseriesGroupsV2ParamsBotClass = "LIKELY_AUTOMATED"` - `const LeakedCredentialTimeseriesGroupsV2ParamsBotClassLikelyHuman LeakedCredentialTimeseriesGroupsV2ParamsBotClass = "LIKELY_HUMAN"` - `CheckResult param.Field[[]LeakedCredentialTimeseriesGroupsV2ParamsCheckResult]` Filters results by leaked credential check result. - `const LeakedCredentialTimeseriesGroupsV2ParamsCheckResultClean LeakedCredentialTimeseriesGroupsV2ParamsCheckResult = "CLEAN"` - `const LeakedCredentialTimeseriesGroupsV2ParamsCheckResultUsernameLeaked LeakedCredentialTimeseriesGroupsV2ParamsCheckResult = "USERNAME_LEAKED"` - `const LeakedCredentialTimeseriesGroupsV2ParamsCheckResultUsernamePasswordSimilar LeakedCredentialTimeseriesGroupsV2ParamsCheckResult = "USERNAME_PASSWORD_SIMILAR"` - `const LeakedCredentialTimeseriesGroupsV2ParamsCheckResultUsernameAndPasswordLeaked LeakedCredentialTimeseriesGroupsV2ParamsCheckResult = "USERNAME_AND_PASSWORD_LEAKED"` - `const LeakedCredentialTimeseriesGroupsV2ParamsCheckResultPasswordLeaked LeakedCredentialTimeseriesGroupsV2ParamsCheckResult = "PASSWORD_LEAKED"` - `Compromised param.Field[[]LeakedCredentialTimeseriesGroupsV2ParamsCompromised]` Filters results by compromised credential status (clean vs. compromised). - `const LeakedCredentialTimeseriesGroupsV2ParamsCompromisedClean LeakedCredentialTimeseriesGroupsV2ParamsCompromised = "CLEAN"` - `const LeakedCredentialTimeseriesGroupsV2ParamsCompromisedCompromised LeakedCredentialTimeseriesGroupsV2ParamsCompromised = "COMPROMISED"` - `Continent param.Field[[]string]` Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA. - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialTimeseriesGroupsV2ParamsFormat]` Format in which results will be returned. - `const LeakedCredentialTimeseriesGroupsV2ParamsFormatJson LeakedCredentialTimeseriesGroupsV2ParamsFormat = "JSON"` - `const LeakedCredentialTimeseriesGroupsV2ParamsFormatCsv LeakedCredentialTimeseriesGroupsV2ParamsFormat = "CSV"` - `LimitPerGroup param.Field[int64]` Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an "other" category. - `Location param.Field[[]string]` Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT. - `Name param.Field[[]string]` Array of names used to label the series in the response. - `Normalization param.Field[LeakedCredentialTimeseriesGroupsV2ParamsNormalization]` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialTimeseriesGroupsV2ParamsNormalizationPercentageChange LeakedCredentialTimeseriesGroupsV2ParamsNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialTimeseriesGroupsV2ParamsNormalizationMin0Max LeakedCredentialTimeseriesGroupsV2ParamsNormalization = "MIN0_MAX"` ### Returns - `type LeakedCredentialTimeseriesGroupsV2Response struct{…}` - `Meta LeakedCredentialTimeseriesGroupsV2ResponseMeta` Metadata for the results. - `AggInterval LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaAggIntervalFifteenMinutes LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval = "FIFTEEN_MINUTES"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaAggIntervalOneHour LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval = "ONE_HOUR"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaAggIntervalOneDay LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval = "ONE_DAY"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaAggIntervalOneWeek LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval = "ONE_WEEK"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaAggIntervalOneMonth LeakedCredentialTimeseriesGroupsV2ResponseMetaAggInterval = "ONE_MONTH"` - `ConfidenceInfo LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialTimeseriesGroupsV2ResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialTimeseriesGroupsV2ResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationPercentage LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationMin0Max LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationMinMax LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationRawValues LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationPercentageChange LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationRollingAverage LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationOverlappedPercentage LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalizationRatio LeakedCredentialTimeseriesGroupsV2ResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialTimeseriesGroupsV2ResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Serie0 LeakedCredentialTimeseriesGroupsV2ResponseSerie0` - `Timestamps []Time` ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.TimeseriesGroupsV2( context.TODO(), radar.LeakedCredentialTimeseriesGroupsV2ParamsDimensionCompromised, radar.LeakedCredentialTimeseriesGroupsV2Params{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "aggInterval": "FIFTEEN_MINUTES", "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "serie_0": { "timestamps": [ "2023-08-08T10:15:00Z" ] } }, "success": true } ``` # Summary ## Get HTTP authentication requests by bot class summary `client.Radar.LeakedCredentials.Summary.BotClass(ctx, query) (*LeakedCredentialSummaryBotClassResponse, error)` **get** `/radar/leaked_credential_checks/summary/bot_class` Retrieves the distribution of HTTP authentication requests by bot class. ### Parameters - `query LeakedCredentialSummaryBotClassParams` - `Compromised param.Field[[]LeakedCredentialSummaryBotClassParamsCompromised]` Filters results by compromised credential status (clean vs. compromised). - `const LeakedCredentialSummaryBotClassParamsCompromisedClean LeakedCredentialSummaryBotClassParamsCompromised = "CLEAN"` - `const LeakedCredentialSummaryBotClassParamsCompromisedCompromised LeakedCredentialSummaryBotClassParamsCompromised = "COMPROMISED"` - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialSummaryBotClassParamsFormat]` Format in which results will be returned. - `const LeakedCredentialSummaryBotClassParamsFormatJson LeakedCredentialSummaryBotClassParamsFormat = "JSON"` - `const LeakedCredentialSummaryBotClassParamsFormatCsv LeakedCredentialSummaryBotClassParamsFormat = "CSV"` - `Name param.Field[[]string]` Array of names used to label the series in the response. ### Returns - `type LeakedCredentialSummaryBotClassResponse struct{…}` - `Meta LeakedCredentialSummaryBotClassResponseMeta` Metadata for the results. - `ConfidenceInfo LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialSummaryBotClassResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialSummaryBotClassResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationPercentage LeakedCredentialSummaryBotClassResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationMin0Max LeakedCredentialSummaryBotClassResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationMinMax LeakedCredentialSummaryBotClassResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationRawValues LeakedCredentialSummaryBotClassResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationPercentageChange LeakedCredentialSummaryBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationRollingAverage LeakedCredentialSummaryBotClassResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationOverlappedPercentage LeakedCredentialSummaryBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialSummaryBotClassResponseMetaNormalizationRatio LeakedCredentialSummaryBotClassResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialSummaryBotClassResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Summary0 LeakedCredentialSummaryBotClassResponseSummary0` - `Bot string` A numeric string. - `Human string` A numeric string. ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.Summary.BotClass(context.TODO(), radar.LeakedCredentialSummaryBotClassParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "summary_0": { "bot": "10", "human": "10" } }, "success": true } ``` ## Get HTTP authentication requests by compromised credential status summary `client.Radar.LeakedCredentials.Summary.Compromised(ctx, query) (*LeakedCredentialSummaryCompromisedResponse, error)` **get** `/radar/leaked_credential_checks/summary/compromised` Retrieves the distribution of HTTP authentication requests by compromised credential status. ### Parameters - `query LeakedCredentialSummaryCompromisedParams` - `BotClass param.Field[[]LeakedCredentialSummaryCompromisedParamsBotClass]` Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - `const LeakedCredentialSummaryCompromisedParamsBotClassLikelyAutomated LeakedCredentialSummaryCompromisedParamsBotClass = "LIKELY_AUTOMATED"` - `const LeakedCredentialSummaryCompromisedParamsBotClassLikelyHuman LeakedCredentialSummaryCompromisedParamsBotClass = "LIKELY_HUMAN"` - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialSummaryCompromisedParamsFormat]` Format in which results will be returned. - `const LeakedCredentialSummaryCompromisedParamsFormatJson LeakedCredentialSummaryCompromisedParamsFormat = "JSON"` - `const LeakedCredentialSummaryCompromisedParamsFormatCsv LeakedCredentialSummaryCompromisedParamsFormat = "CSV"` - `Name param.Field[[]string]` Array of names used to label the series in the response. ### Returns - `type LeakedCredentialSummaryCompromisedResponse struct{…}` - `Meta LeakedCredentialSummaryCompromisedResponseMeta` Metadata for the results. - `ConfidenceInfo LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialSummaryCompromisedResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialSummaryCompromisedResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationPercentage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationMin0Max LeakedCredentialSummaryCompromisedResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationMinMax LeakedCredentialSummaryCompromisedResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationRawValues LeakedCredentialSummaryCompromisedResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationPercentageChange LeakedCredentialSummaryCompromisedResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationRollingAverage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationOverlappedPercentage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialSummaryCompromisedResponseMetaNormalizationRatio LeakedCredentialSummaryCompromisedResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialSummaryCompromisedResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Summary0 LeakedCredentialSummaryCompromisedResponseSummary0` - `Clean string` A numeric string. - `Compromised string` A numeric string. ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.Summary.Compromised(context.TODO(), radar.LeakedCredentialSummaryCompromisedParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "summary_0": { "CLEAN": "10", "COMPROMISED": "10" } }, "success": true } ``` # Timeseries Groups ## Get HTTP authentication requests by bot class time series `client.Radar.LeakedCredentials.TimeseriesGroups.BotClass(ctx, query) (*LeakedCredentialTimeseriesGroupBotClassResponse, error)` **get** `/radar/leaked_credential_checks/timeseries_groups/bot_class` Retrieves the distribution of HTTP authentication requests by bot class over time. ### Parameters - `query LeakedCredentialTimeseriesGroupBotClassParams` - `AggInterval param.Field[LeakedCredentialTimeseriesGroupBotClassParamsAggInterval]` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupBotClassParamsAggInterval15m LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "15m"` - `const LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1h LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1h"` - `const LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1d LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1d"` - `const LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1w LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1w"` - `Compromised param.Field[[]LeakedCredentialTimeseriesGroupBotClassParamsCompromised]` Filters results by compromised credential status (clean vs. compromised). - `const LeakedCredentialTimeseriesGroupBotClassParamsCompromisedClean LeakedCredentialTimeseriesGroupBotClassParamsCompromised = "CLEAN"` - `const LeakedCredentialTimeseriesGroupBotClassParamsCompromisedCompromised LeakedCredentialTimeseriesGroupBotClassParamsCompromised = "COMPROMISED"` - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialTimeseriesGroupBotClassParamsFormat]` Format in which results will be returned. - `const LeakedCredentialTimeseriesGroupBotClassParamsFormatJson LeakedCredentialTimeseriesGroupBotClassParamsFormat = "JSON"` - `const LeakedCredentialTimeseriesGroupBotClassParamsFormatCsv LeakedCredentialTimeseriesGroupBotClassParamsFormat = "CSV"` - `Name param.Field[[]string]` Array of names used to label the series in the response. ### Returns - `type LeakedCredentialTimeseriesGroupBotClassResponse struct{…}` - `Meta LeakedCredentialTimeseriesGroupBotClassResponseMeta` Metadata for the results. - `AggInterval LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalFifteenMinutes LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "FIFTEEN_MINUTES"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneHour LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_HOUR"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneDay LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_DAY"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneWeek LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_WEEK"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneMonth LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_MONTH"` - `ConfidenceInfo LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationPercentage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationMin0Max LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationMinMax LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRawValues LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationPercentageChange LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRollingAverage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationOverlappedPercentage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRatio LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Serie0 LeakedCredentialTimeseriesGroupBotClassResponseSerie0` - `Bot []string` - `Human []string` - `Timestamps []Time` ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.TimeseriesGroups.BotClass(context.TODO(), radar.LeakedCredentialTimeseriesGroupBotClassParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "aggInterval": "FIFTEEN_MINUTES", "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "serie_0": { "bot": [ "10" ], "human": [ "10" ], "timestamps": [ "2019-12-27T18:11:19.117Z" ] } }, "success": true } ``` ## Get HTTP authentication requests by compromised credential status time series `client.Radar.LeakedCredentials.TimeseriesGroups.Compromised(ctx, query) (*LeakedCredentialTimeseriesGroupCompromisedResponse, error)` **get** `/radar/leaked_credential_checks/timeseries_groups/compromised` Retrieves the distribution of HTTP authentication requests by compromised credential status over time. ### Parameters - `query LeakedCredentialTimeseriesGroupCompromisedParams` - `AggInterval param.Field[LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval]` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval15m LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "15m"` - `const LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1h LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1h"` - `const LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1d LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1d"` - `const LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1w LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1w"` - `BotClass param.Field[[]LeakedCredentialTimeseriesGroupCompromisedParamsBotClass]` Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - `const LeakedCredentialTimeseriesGroupCompromisedParamsBotClassLikelyAutomated LeakedCredentialTimeseriesGroupCompromisedParamsBotClass = "LIKELY_AUTOMATED"` - `const LeakedCredentialTimeseriesGroupCompromisedParamsBotClassLikelyHuman LeakedCredentialTimeseriesGroupCompromisedParamsBotClass = "LIKELY_HUMAN"` - `DateEnd param.Field[[]Time]` End of the date range (inclusive). - `DateRange param.Field[[]string]` Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). - `DateStart param.Field[[]Time]` Start of the date range. - `Format param.Field[LeakedCredentialTimeseriesGroupCompromisedParamsFormat]` Format in which results will be returned. - `const LeakedCredentialTimeseriesGroupCompromisedParamsFormatJson LeakedCredentialTimeseriesGroupCompromisedParamsFormat = "JSON"` - `const LeakedCredentialTimeseriesGroupCompromisedParamsFormatCsv LeakedCredentialTimeseriesGroupCompromisedParamsFormat = "CSV"` - `Name param.Field[[]string]` Array of names used to label the series in the response. ### Returns - `type LeakedCredentialTimeseriesGroupCompromisedResponse struct{…}` - `Meta LeakedCredentialTimeseriesGroupCompromisedResponseMeta` Metadata for the results. - `AggInterval LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval` Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalFifteenMinutes LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "FIFTEEN_MINUTES"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneHour LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_HOUR"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneDay LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_DAY"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneWeek LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_WEEK"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneMonth LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_MONTH"` - `ConfidenceInfo LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo` - `Annotations []LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation` - `DataSource LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource` Data source for annotations. - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAll LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAIBots LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceBGP LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceBots LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceCT LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "CT"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNS LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceDos LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceFw LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "FW"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceFwPg LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTP LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceIQI LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceNet LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "NET"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceSpeed LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"` - `Description string` - `EndDate Time` - `EventType LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType` Event type for annotations. - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeEvent LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeGeneral LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeOutage LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypePipeline LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"` - `IsInstantaneous bool` Whether event is a single point in time or a time range. - `LinkedURL string` - `StartDate Time` - `Level int64` Provides an indication of how much confidence Cloudflare has in the data. - `DateRange []LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange` - `EndTime Time` Adjusted end of date range. - `StartTime Time` Adjusted start of date range. - `LastUpdated Time` Timestamp of the last dataset update. - `Normalization LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization` Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationPercentage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationMin0Max LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "MIN0_MAX"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationMinMax LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "MIN_MAX"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRawValues LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "RAW_VALUES"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationPercentageChange LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "PERCENTAGE_CHANGE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRollingAverage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "ROLLING_AVERAGE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationOverlappedPercentage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"` - `const LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRatio LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "RATIO"` - `Units []LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit` Measurement units for the results. - `Name string` - `Value string` - `Serie0 LeakedCredentialTimeseriesGroupCompromisedResponseSerie0` - `Clean []string` - `Compromised []string` - `Timestamps []Time` ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/radar" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.Radar.LeakedCredentials.TimeseriesGroups.Compromised(context.TODO(), radar.LeakedCredentialTimeseriesGroupCompromisedParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Meta) } ``` #### Response ```json { "result": { "meta": { "aggInterval": "FIFTEEN_MINUTES", "confidenceInfo": { "annotations": [ { "dataSource": "ALL", "description": "Cable cut in Tonga", "endDate": "2019-12-27T18:11:19.117Z", "eventType": "EVENT", "isInstantaneous": true, "linkedUrl": "https://example.com", "startDate": "2019-12-27T18:11:19.117Z" } ], "level": 0 }, "dateRange": [ { "endTime": "2022-09-17T10:22:57.555Z", "startTime": "2022-09-16T10:22:57.555Z" } ], "lastUpdated": "2019-12-27T18:11:19.117Z", "normalization": "PERCENTAGE", "units": [ { "name": "*", "value": "requests" } ] }, "serie_0": { "CLEAN": [ "10" ], "COMPROMISED": [ "10" ], "timestamps": [ "2019-12-27T18:11:19.117Z" ] } }, "success": true } ```