{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdGroupFrequencyCapFilter":{"description":"Filter that can be set for adgroup level frequency cap.","properties":{"adGroupIds":{"description":"List of adGroup Ids. When this list is empty, frequency savings insights from all frequency group under the advertiser will be returned in the response. When the list is not empty, frequency savings insights will be filtered to the list of adGroup Ids set.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"campaignIds":{"description":"List of campaign Ids.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"frequencyCapType":{"$ref":"#/components/schemas/AdgroupFrequencyCapType"}},"type":"object"},"AdgroupFrequencyCapType":{"enum":["ADGROUP_FREQUENCY_CAP"],"type":"string"},"CampaignFrequencyCapFilter":{"description":"Filter that can be set for campaign level frequency cap.","properties":{"campaignIds":{"description":"List of campaign Ids.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"frequencyCapType":{"$ref":"#/components/schemas/CampaignFrequencyCapType"}},"type":"object"},"CampaignFrequencyCapType":{"enum":["CAMPAIGN_FREQUENCY_CAP"],"type":"string"},"DspBadRequestExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspForbiddenExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspInternalServerExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspNotFoundExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspSubError":{"properties":{"errorCode":{"type":"string"},"errorId":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspTooManyRequestsExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"FrequencyBin":{"enum":["1","10+","2","3","4","5","6","7","8","9"],"type":"string"},"FrequencyCapType":{"enum":["ADGROUP_FREQUENCY_CAP","CAMPAIGN_FREQUENCY_CAP","FREQUENCY_GROUP_FREQUENCY_CAP"],"type":"string"},"FrequencyCapTypeFilterUnion":{"oneOf":[{"properties":{"campaignFrequencyCapFilter":{"$ref":"#/components/schemas/CampaignFrequencyCapFilter"}},"required":["campaignFrequencyCapFilter"],"title":"campaignFrequencyCapFilter","type":"object"},{"properties":{"adGroupFrequencyCapFilter":{"$ref":"#/components/schemas/AdGroupFrequencyCapFilter"}},"required":["adGroupFrequencyCapFilter"],"title":"adGroupFrequencyCapFilter","type":"object"},{"properties":{"frequencyGroupFrequencyCapFilter":{"$ref":"#/components/schemas/FrequencyGroupFrequencyCapFilter"}},"required":["frequencyGroupFrequencyCapFilter"],"title":"frequencyGroupFrequencyCapFilter","type":"object"}]},"FrequencyDistributionItem":{"description":"Frequency distribution insight item.","properties":{"adGroupId":{"description":"ID of the ad group. Only included when level is AD_GROUP.","type":"string"},"advertiserId":{"description":"ID of the advertiser.","type":"string"},"campaignCountry":{"description":"The 2-letter ISO country code of the campaign (e.g., US, CA, MX).","type":"string"},"campaignId":{"description":"ID of the campaign. Always included.","type":"string"},"date":{"description":"The date for which the data is reported.","type":"string"},"frequency":{"$ref":"#/components/schemas/FrequencyBin"},"level":{"$ref":"#/components/schemas/Level"},"metrics":{"description":"Performance metrics for this frequency bin.","items":{"$ref":"#/components/schemas/FrequencyDistributionMetric"},"type":"array"},"timeGrain":{"$ref":"#/components/schemas/TimeGrain"}},"type":"object"},"FrequencyDistributionMetric":{"description":"Performance metric data.","properties":{"metricName":{"$ref":"#/components/schemas/FrequencyDistributionMetricName"},"metricValue":{"description":"Value of the performance metric.","format":"double","type":"number"},"noDataReasonCode":{"$ref":"#/components/schemas/FrequencyDistributionNoDataReasonCode"}},"type":"object"},"FrequencyDistributionMetricName":{"enum":["COMBINED_ROAS","COMPLETION_RATE","CPA","CPC","CPD","CPDPV","CPVC","CTR","DPVR","HOUSEHOLD_COMBINED_ROAS","HOUSEHOLD_COMPLETION_RATE","HOUSEHOLD_CPA","HOUSEHOLD_CPC","HOUSEHOLD_CPD","HOUSEHOLD_CPDPV","HOUSEHOLD_CPVC","HOUSEHOLD_CTR","HOUSEHOLD_DPVR","HOUSEHOLD_REACH","HOUSEHOLD_ROAS","HOUSEHOLD_TOTAL_CPSU","HOUSEHOLD_TOTAL_ROAS","REACH","ROAS","TOTAL_CPSU","TOTAL_ROAS"],"type":"string"},"FrequencyDistributionNoDataReasonCode":{"description":"Reason why metric data is not available. INSUFFICIENT_DATA indicates not enough data points to calculate the metric reliably. METRIC_NOT_APPLICABLE indicates the metric is not applicable for the specific ad format or campaign type.","enum":["INSUFFICIENT_DATA","METRIC_NOT_APPLICABLE"],"type":"string"},"FrequencyDistributionRequest":{"description":"Request object to fetch frequency distribution insights for ad groups and campaigns.","properties":{"filters":{"$ref":"#/components/schemas/FrequencyDistributionRequestFilters"},"maxResults":{"description":"Maximum number of results to return per page. Minimum: 0, Maximum: 10000, Default: 10000","maximum":10000,"minimum":0,"type":"integer"},"nextToken":{"description":"Token to fetch additional results (if any). Subsequent calls must be made with same parameters as in the previous requests.","type":"string"}},"required":["filters"],"type":"object"},"FrequencyDistributionRequestFilters":{"description":"Filters to apply to the frequency distribution insights.","properties":{"adGroupIdFilter":{"description":"List of ad group IDs to filter by. Only applicable when level is AD_GROUP.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"advertiserIdFilter":{"description":"List of advertiser IDs to filter by. If not provided, data for all advertisers the user has access to will be returned. Currently, only one advertiser ID is supported, but the API is designed to support multiple IDs in the future.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"campaignIdFilter":{"description":"List of campaign IDs to filter by. When level is CAMPAIGN, this filter specifies which campaigns to retrieve data for. When level is AD_GROUP, this filter specifies the parent campaign and the API will return requested ad groups under that campaigns. Only applicable when level is AD_GROUP or CAMPAIGN.","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"endDateFilter":{"description":"End date until which frequency distribution insights will be returned. Must be within the past 90 days. If not set, defaults to current date. If only end date is set, returns data from end date - 90 days to end date. If both start and end date are set, returns data for the entire date range up to 90 days.","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"levelFilter":{"$ref":"#/components/schemas/Level"},"metricsFilter":{"description":"List of performance metrics to include in the response.","items":{"$ref":"#/components/schemas/FrequencyDistributionMetricName"},"maxItems":1000,"minItems":0,"type":"array"},"startDateFilter":{"description":"Start date from which frequency distribution insights will be returned. Must be within the past 90 days. If not set, defaults to last 15 days from end date. If only start date is set, returns data from start date to start date + 90 days.","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"timeGrainFilter":{"$ref":"#/components/schemas/TimeGrain"}},"type":"object"},"FrequencyDistributionResponse":{"description":"Response object containing frequency distribution insights.","properties":{"frequencyDistributionInsights":{"description":"List of frequency distribution insights.","items":{"$ref":"#/components/schemas/FrequencyDistributionItem"},"type":"array"},"nextToken":{"description":"Token to fetch additional results (if any). Subsequent calls must be made with same parameters as in the previous requests.","type":"string"}},"type":"object"},"FrequencyGroupFrequencyCapFilter":{"description":"Filter that can be set for frequency group level frequency cap.","properties":{"frequencyCapType":{"$ref":"#/components/schemas/FrequencyGroupFrequencyCapType"},"frequencyGroupIds":{"description":"List of frequency group Ids. When this list is empty, frequency savings insights from all frequency group under the advertiser will be returned in the response. When the list is not empty, frequency savings insights will be filtered to the list of frequency group Ids set.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"type":"object"},"FrequencyGroupFrequencyCapType":{"enum":["FREQUENCY_GROUP_FREQUENCY_CAP"],"type":"string"},"FrequencySavingsInsights":{"properties":{"adGroupId":{"description":"Represents the ID of the adgroup associated with the frequency savings insight. Will be included if adGroupFrequencyCapFilter is used and adGroupIds are not empty.","type":"string"},"advertiserId":{"description":"Represents the ID of the advertiser associated with the frequency savings insight.","type":"string"},"campaignCountry":{"description":"The 2-letter ISO country code of the campaign (e.g., US, CA, MX).","type":"string"},"campaignId":{"description":"Represents the ID of the campaign associated with the insight. Will be included if campaignFrequencyCapFilter or adGroupFrequencyCapFilter filter is used and campaignIds are not empty.","type":"string"},"date":{"description":"Represents the day of the insight.","type":"string"},"frequencyGroupId":{"description":"Represents the ID of the frequency group associated with the insight. Will be included if frequencyGroupFrequencyCapfilter is used and frequencyGroupIds are not empty.","type":"string"},"metrics":{"$ref":"#/components/schemas/Metrics"}},"type":"object"},"Level":{"enum":["AD_GROUP","CAMPAIGN"],"type":"string"},"ListFrequencySavingsInsightsRequestContent":{"description":"Request object to fetch frequency savings insights.","properties":{"filters":{"$ref":"#/components/schemas/ListFrequencySavingsInsightsRequestFilters"},"maxResults":{"description":"max results to return per page.","maximum":10000,"minimum":1,"type":"integer"},"nextToken":{"description":"Token to fetch additional results (if any). Subsequent calls must be made with same parameters as in the previous requests.","type":"string"}},"required":["filters"],"type":"object"},"ListFrequencySavingsInsightsRequestFilters":{"properties":{"advertiserIdFilter":{"description":"List of advertiser Ids.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"endDateFilter":{"description":"end date until which frequency savings insights will be returned.","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"frequencyCapTypeFilter":{"$ref":"#/components/schemas/FrequencyCapTypeFilterUnion"},"metricsFilter":{"description":"List of metric names you would like to be included in the results.","items":{"$ref":"#/components/schemas/MetricName"},"maxItems":4,"minItems":1,"type":"array"},"startDateFilter":{"description":"start date from which frequency savings insights will be returned.","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},"type":"object"},"ListFrequencySavingsInsightsResponseContent":{"description":"Response object containing frequency savings insights.","properties":{"frequencyCapType":{"$ref":"#/components/schemas/FrequencyCapType"},"frequencySavingsInsights":{"description":"List of frequency savings insights.","items":{"$ref":"#/components/schemas/FrequencySavingsInsights"},"type":"array"},"nextToken":{"description":"Token to fetch additional results (if any). Subsequent calls must be made with same  parameters as in the previous requests.","type":"string"}},"type":"object"},"MetricName":{"enum":["HOUSEHOLD_SAVINGS_REINVESTED_AMOUNT","INCREMENTAL_HOUSEHOLD_COUNT","INCREMENTAL_USERS_COUNT","SAVED_HOUSEHOLD_IMPRESSIONS_COUNT","SAVED_IMPRESSIONS_COUNT","SAVINGS_REINVESTED_AMOUNT","UNIQUE_HOUSEHOLD_COUNT","UNIQUE_USERS_COUNT"],"type":"string"},"Metrics":{"properties":{"currencyCode":{"type":"string"},"metricName":{"$ref":"#/components/schemas/MetricName"},"metricValue":{"format":"double","type":"number"},"noDataReasonCode":{"$ref":"#/components/schemas/NoDataReasonCode"}},"type":"object"},"NoDataReasonCode":{"enum":["FREQUENCY_CAP_NOT_REACHED","FREQUENCY_CAP_NOT_SET","NOT_AVAILABLE"],"type":"string"},"TimeGrain":{"enum":["DAILY","MONTHLY","WEEKLY"],"type":"string"}},"securitySchemes":{}},"info":{"description":"Amazon Ads DSP Frequency Savings Insights - V1","title":"D16GDspApiActionableInsights","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/v1/frequencyDistributionInsights/list":{"post":{"description":"Gets frequency distribution insights for Amazon DSP, showing the number of unique users exposed to ads at different frequency levels (1-10+ times), along with corresponding performance metrics for each frequency bin.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"ListFrequencyDistributionInsightsV1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Advertising-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspFrequencyDistributionInsight.v1+json":{"schema":{"$ref":"#/components/schemas/FrequencyDistributionRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspFrequencyDistributionInsight.v1+json":{"schema":{"$ref":"#/components/schemas/FrequencyDistributionResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Distribution Insight"]}},"/dsp/v1/frequencySavingsInsights/list":{"post":{"description":"Gets frequency savings insights for Amazon DSP.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"ListFrequencySavingsInsightsV1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Advertising-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspFrequencySavingsInsight.v1+json":{"schema":{"$ref":"#/components/schemas/ListFrequencySavingsInsightsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspFrequencySavingsInsight.v1+json":{"schema":{"$ref":"#/components/schemas/ListFrequencySavingsInsightsResponseContent"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Savings Insight"]}}}}