{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"CampaignDiagnosticsAuthorizationException":{"description":"401 Unauthorized Exception.","properties":{"errorMessage":{"example":"Unauthorized Request.","type":"string"},"requestId":{"example":"cgdg36747bdjhd","type":"string"}},"required":["errorMessage","requestId"],"type":"object"},"CampaignDiagnosticsInternalException":{"description":"500 Internal Exception.","properties":{"errorMessage":{"example":"Error from internal server connections.","type":"string"},"requestId":{"example":"cgdg36747bdjhd","type":"string"}},"required":["errorMessage","requestId"],"type":"object"},"CampaignDiagnosticsRequest":{"description":"A request to run diagnostics to retrieve issues impacting campaigns.","properties":{"campaignIdsList":{"description":"A list of campaign identifiers to be diagnosed.","example":["A08791693CDAWT8LC4"],"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"includeOnlyActive":{"default":"false","description":"Includes diagnostics information for only enabled entities. By default the response includes diagnostics information for both \u0027Enabled\u0027 and \u0027Paused\u0027 entities.","type":"boolean"},"issueTypeFilter":{"description":"Specifies the issue types to be included. By default the response will include all issue types.","example":["FEATURED_OFFER"],"items":{"$ref":"#/components/schemas/IssueType"},"maxItems":3,"minItems":1,"type":"array"},"locale":{"default":"en_US","description":"Specifies the language in which diagnostics information is returned. By default value is set to en_US. Value must be one of the following en_US, zh_CN, es_MX, es_ES, de_DE, fr_FR, it_IT, ja_JP, ko_KR, pt_BR, nl_NL, en_CA, fr_CA, en_GB, tr_TR, en_AE, ar_AE, en_AU, en_IN, hi_IN, ta_IN, ru_RU, en_SG, pl_PL, sv_SE, vi_VN, th_TH, es_CO, zh_TW","type":"string"},"maxIssuesPerCampaign":{"default":"100","description":"Sets a limit on the number of issues returned for a campaign. Default value is set to 100 and maximum value supported is 1000.","example":"100","maximum":1000,"minimum":1,"type":"integer"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","example":"96cae35ce8a9b0244178bf28e4966c2ce1b8385723a96a6b838858cdd6ca0a1e","type":"string"},"severityFilter":{"description":"Specifies the issue severities to be included. By default the response will include all issue severities.","example":["CRITICAL"],"items":{"$ref":"#/components/schemas/Severity"},"maxItems":2,"minItems":1,"type":"array"}},"required":["campaignIdsList"],"type":"object"},"CampaignDiagnosticsResponse":{"description":"A list of issues diagnosed for the campaigns specified by the requester.","properties":{"campaignDiagnosticsList":{"description":"A list of diagnosed campaigns with information on identified issues.","items":{"$ref":"#/components/schemas/campaignDiagnosticsList"},"maxItems":50,"minItems":0,"type":"array"},"errorsList":{"description":"Errors from api request.","items":{"$ref":"#/components/schemas/Error"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","example":"96cae35ce8a9b0244178bf28e4966c2ce1b8385723a96a6b838858cdd6ca0a1e","type":"string"},"requestId":{"example":"cgdg36747bdjhd","type":"string"}},"required":["campaignDiagnosticsList","errorsList","requestId"],"type":"object"},"CampaignDiagnosticsThrottlingException":{"description":"429 Throttling Exception.","properties":{"errorMessage":{"example":"Client is exceeding the request rate limits for an advertiser.","type":"string"},"requestId":{"example":"cgdg36747bdjhd","type":"string"}},"required":["errorMessage","requestId"],"type":"object"},"CampaignDiagnosticsValidationException":{"description":"400 Validation Exception.","properties":{"errorMessage":{"example":"campaignIdsList was not contained in payload.","type":"string"},"requestId":{"example":"cgdg36747bdjhd","type":"string"}},"required":["errorMessage","requestId"],"type":"object"},"Error":{"properties":{"errorCode":{"description":"Enum indicating the category of error. Example `NOT_FOUND`.","example":"NOT_FOUND","type":"string"},"errorMessage":{"description":"Error message provided.","example":"CampaignId provided was not Found","type":"string"},"itemRequestId":{"description":"Campaign identifier.","example":"AAA08791693CDAWT8LC4","type":"string"}},"required":["errorCode","errorMessage","itemRequestId"],"type":"object"},"Issue":{"description":"Captures issue details.","properties":{"impact":{"description":"Captures the impact of the issue across the campaign.","properties":{"entityIdentifier":{"description":"An Amazon product identifier or seller product identifier.","example":"test_sku","type":"string"},"entityType":{"description":"Field to mention the impacted entityType for the issue. Possible entityType values are \u0027ASIN\u0027 or \u0027SKU\u0027 and the value is based off the issueType value.","example":"SKU","type":"string"},"numAdsImpacted":{"description":"A count of ads impacted by the entity.","example":"10","type":"integer"},"supplementalInfo":{"description":"Provides the corresponding ASIN information in case of seller product issue, reflected as \u0027SKU\u0027 in entityType.","properties":{"asin":{"description":"Amazon product identifier.","example":"B07X6C9RMF","type":"string"}},"type":"object"}},"required":["entityIdentifier","entityType","numAdsImpacted"],"type":"object"},"information":{"description":"A human readable description of the issue including possible remediations, wherever applicable.","example":"Because we only allow ads from Featured Offer winners, this might be affecting the impressions for this ad. We select the Featured Offer based on multiple factors such as price, availability, delivery speed, and customer service.","type":"string"},"issueCode":{"description":"Describes the specific issue code under the broader issueType, for example MISSING_IMAGE.","example":"MISSING_IMAGE","type":"string"},"issueType":{"$ref":"#/components/schemas/IssueType"},"severity":{"$ref":"#/components/schemas/Severity"}},"required":["impact","information","issueCode","issueType","severity"],"type":"object"},"IssueType":{"description":"Describes the type of the issue, for example FEATURED OFFER, PRODUCT_ELIGIBILITY, MODERATION.","type":"string"},"Severity":{"description":"Describes the severity of the issue whether it is CRITICAL or WARNING.","type":"string"},"campaignDiagnosticsList":{"description":"A list of diagnosed campaigns with information on identified issues.","properties":{"campaignId":{"description":"Campaign identifier.","example":"A08791693CDAWT8LC4","type":"string"},"issuesList":{"description":"A list of issues impacting the campaign.","items":{"$ref":"#/components/schemas/Issue"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["campaignId","issuesList"],"type":"object"}},"securitySchemes":{}},"info":{"description":"The Campaign Diagnostics API ([POST /diagnostics/campaigns/issues](https://advertising.amazon.com/API/docs/en-us/campaign-diagnostics)) will be deprecated on December 01, 2025. New users will no longer be able to make requests as of June 20, 2025. All existing access to the API will be shut off on December 01, 2025","title":"Diagnostics","version":"3.0"},"openapi":"3.0.1","paths":{"/diagnostics/campaigns/issues":{"post":{"description":"Creates the advertiser campaign issues, for all advertising campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\",\"advertiser_campaign_edit\"]","operationId":"campaignDiagnostics","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsRequest"}}}},"responses":{"207":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsResponse"}}},"description":"Successful Operation."},"400":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsValidationException"}}},"description":"Validation Exception."},"401":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsAuthorizationException"}}},"description":"Unauthorized Exception."},"429":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsThrottlingException"}}},"description":"Throttling Exception."},"500":{"content":{"application/vnd.campaigndiagnosticsissues.v1+json":{"schema":{"$ref":"#/components/schemas/CampaignDiagnosticsInternalException"}}},"description":"Internal Exception."}},"summary":"Returns campaign issues","tags":["Advertising Campaign Diagnostics"]}}}}