{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Advertiser Account.","in":"header","name":"Amazon-Ads-AccountId","schema":{"type":"string"}},"AdProductQuery":{"description":"\n**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |\n","in":"query","name":"adProduct","required":true,"schema":{"$ref":"#/components/schemas/AdProduct"}},"AdvertisingDealIdQuery":{"in":"query","name":"advertisingDealId","required":true,"schema":{"type":"string"}},"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ManagerAccountIdHeaderOptional":{"description":"The identifier of an Amazon Ads Manager Account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"type":"string"}},"MaxResultsQuery":{"in":"query","name":"maxResults","schema":{"default":100,"format":"int32","maximum":500,"minimum":1,"type":"integer"}},"NextTokenQuery":{"in":"query","name":"nextToken","schema":{"type":"string"}},"PerformanceEndDateQuery":{"in":"query","name":"performanceEndDate","schema":{"format":"date-time","type":"string"}},"PerformanceStartDateQuery":{"in":"query","name":"performanceStartDate","schema":{"format":"date-time","type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdProduct":{"description":"**AdProduct Enum:**\n| AdProduct | Description |\n| --- | --- |\n| `AMAZON_DSP` | Amazon Demand-Side Platform ad product. |","enum":["AMAZON_DSP"],"type":"string"},"AvailsForDeviceType":{"description":"Avails breakdown for a specific device type.","properties":{"deviceType":{"$ref":"#/components/schemas/DeviceType"},"impressionOpportunities":{"description":"The number of impression opportunities per day per device.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["deviceType","impressionOpportunities"],"type":"object"},"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"DealPerformance":{"properties":{"adProduct":{"$ref":"#/components/schemas/AdProduct"},"advertisingDealId":{"description":"Reference to the associated advertising deal.","type":"string"},"availsByDeviceType":{"description":"A list of avails broken down by device type.","items":{"$ref":"#/components/schemas/AvailsForDeviceType"},"maxItems":30,"minItems":0,"type":"array"},"availsTotal":{"description":"The total number of impression opportunities.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"averageCpm":{"description":"Historical cost per thousand impressions over the period of time specified.","format":"double","type":"number"},"bidRequests":{"description":"The volume of bids with this deal ID that are eligible for the Amazon DSP.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"bidResponses":{"description":"The number of bid responses sent back to SSP or publisher for the applicable deal ID.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"clickthroughCount":{"description":"The number of times an ad is clicked.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"completionCount":{"description":"The number of times a video or audio ad is completed.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"conversionCount":{"description":"The number of times an impression resulted in an action.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"dealPerformanceId":{"description":"A unique identifier for the performance record.","type":"string"},"measurableImpressions":{"description":"The number of impressions that were measurable.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"metricsLastUpdated":{"description":"Last time the metrics were updated.","format":"date-time","type":"string"},"performanceEndDate":{"description":"End date for performance metrics period.","format":"date-time","type":"string"},"performanceStartDate":{"description":"Start date for performance metrics period.","format":"date-time","type":"string"},"recognizedBids":{"description":"The number of bid requests which include a recognized deal ID. This is divided by total bid requests for the deal to get recognition rate.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"totalImpressions":{"description":"The number of times an advertisement was displayed.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"totalSpend":{"description":"The total amount spent on the deal over the period of time specified.","format":"double","type":"number"},"viewableImpressions":{"description":"The number of impressions that were viewable.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["adProduct","advertisingDealId","dealPerformanceId"],"type":"object"},"DealPerformanceSuccessResponse":{"properties":{"dealPerformances":{"items":{"$ref":"#/components/schemas/DealPerformance"},"maxItems":500,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"DeviceType":{"description":"**DeviceType Enum:**\n| DeviceType | Description |\n| --- | --- |\n| `DESKTOP` | Desktop computers and laptops. |\n| `MOBILE` | Mobile phones and tablets. |\n| `CONNECTED_TV` | Connected TV devices. |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |\n| `UNKNOWN` | Unknown or unrecognized device type. |","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE","UNKNOWN"],"type":"string"},"ErrorCode":{"description":"**ErrorCode Enum:**\n| ErrorCode | Description |\n| --- | --- |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |","enum":["BAD_REQUEST","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"DealPerformances API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/dealPerformances":{"get":{"description":"Retrieve performance metrics for each specified deal.\n\n**Requires one of these permissions**:\n[\"inventory_view\"]","operationId":"ListDealPerformance","parameters":[{"$ref":"#/components/parameters/AdProductQuery"},{"$ref":"#/components/parameters/AdvertisingDealIdQuery"},{"$ref":"#/components/parameters/PerformanceEndDateQuery"},{"$ref":"#/components/parameters/PerformanceStartDateQuery"},{"$ref":"#/components/parameters/NextTokenQuery"},{"$ref":"#/components/parameters/MaxResultsQuery"},{"$ref":"#/components/parameters/AccountIdHeaderOptional"},{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ManagerAccountIdHeaderOptional"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealPerformanceSuccessResponse"}}},"description":"ListDealPerformance 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["DealPerformances"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}