Support

  • Welcome
  • Video Central
  • Supported features
  • Finances
  • VOD delivery onboarding
  • Business-specific requirements
  • Availability and delivery
  • Prime Video packaging summary
  • Packaging requirements — US/UK/DE/JP (Classic)
  • Packaging requirements — All other territories (Global)
  • One Catalog
  • Technical asset requirements
  • Sample files
  • Ratings, languages, and genres
  • Frequently Asked Questions (FAQs)
  • Video tutorials
  • Video Central API
  • Legal

Your email has been sent

You should receive a response from Customer Service within one business day.

API documentation

Video Central reporting APIs enable developers to build clients to retrieve reporting-related information like available report types and the download URL for those reports. This article provides information about using those APIs.

Authentication

Video Central reporting APIs leverage Login With Amazon (LWA) to authenticate requests. For more information on how to set up LWA, see the LWA documentation.

Requests should include a valid LWA authentication token in the request authorization header.


curl -H "Authorization: Bearer Atza|auth_token" https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts

It the request header doesn't include the token or if the token is expired, the APIs will return an unauthorized exception.

Pagination

All Video Central API responses are paginated. Pagination parameters are specified through requests parameters.

Request parameter

Default value

Description

limit

10

The number of documents returned in a single page. (i.e. the page size)

offset

0

The number of pages to skip. (i.e. page number)

All paginated responses contain the following fields:

Field

Description

total

The total document count in all pages.

next

The URL to the next page. Null if the last page.

Accounts

This resource returns the list of Video Central accounts that the user can access. The set of accounts is accessible in Video Central through the accounts list at the top right corner of the window.

The resource is accessible through https://videocentral.amazon.com/apis/v1/accounts. The following is an example response:


{
   "total":3,
   "next":"https://videocentral.amazon.com/apis/v1/accounts?offset=2&limit=2",
   "data":[
      {
         "id":"123",
         "name":"Account 1"
      },
      {
         "id":"321",
         "name":"Account 2"
      }
   ]
}

Report groups

This resource returns the groups of reports like Channels and Rent or Buy that the user can access. The groups are available in the Video Central on the Reporting tab.

The resource is accessible through https://videocentral.amazon.com/apis/v1/accounts/{account_id}. The following is an example response:


{
  "next": null,
  "total": 1,
  "data": [
    {
      "id": "channels",
      "name": "Channels"
    }
  ]
}

Channels and studios

This resource returns the list of channels or studios available for this account depending on the given reports group. The list of channels or studios is accessible through Video Central through the Channels dropdown on the Reporting tab.

The resource is accessible through https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}. The following is an example response:


{
   "next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium?limit=2&offset=2",
   "total":3,
   "data":[
      {
         "id":"5fb81476-88ca-370e-b158-7e3d04e0a75e",
         "name":"Channel 1",
         "territory":"US"
      },
      {
         "id":"756d9819-74ef-32e1-9c65-b2665b7ac867",
         "name":"Channel 2",
         "territory":"US"
      }
   ]
}

Report types

This resource returns the list of report types available for a given channel or studio. The report types are available in the Reporting tab in Video Central.

The resource is accessible through https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes. The following is an example response:


{
   "next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/5fb81476-88ca-370e-b158-7e3d04e0a75e/reportTypes?limit=2&offset=2",
   "total":10,
   "data":[
      {
         "name":"Content Usage",
         "cadence":"Weekly",
         "id":"amzn1.vcpa.arcs.insight.8ff7afff-2099-47fd-a58c-fc8de96ffff"
      },
      {
         "name":"Content Usage",
         "cadence":"Monthly",
         "reportTypeId":"amzn1.vcpa.arcs.insight.3d1a7d87-a21a-444b-b887-49db54c5ffff"
      }
   ]
}

Reports

This resource returns the list of reports available for a given report type. The reports are available in the reports drop-down list corresponding to the report type.

The resource is accessible through https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reports. The following is an example response:


{
   "total":2,
   "next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/123/reportType/123?offset=2&limit=2",
   "data":[
      {
         "numRows":20,
         "downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/...",
         "reportDateBegin":"2019-01-01",
         "reportDateEnd":"2019-01-07",
         "modifiedDate":"2020-09-02T21:09:16.045Z",
         "name": "Sales",
         "cadence": "Daily"
      },
      {
         "numRows":20,
         "downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/",
         "reportDateBegin":"2019-01-07",
         "reportDateEnd":"2019-01-14",
         "modifiedDate":"2020-09-02T21:09:16.045Z",
         "name": "Sales",
         "cadence": "Daily"
      }
   ]
} 

Additionally, the resource accepts parameters that enable searching and filtering reports for a specific data range. The following table outlines the supported request parameters:

Request parameter

Description

reportDateBeginGte

Returns only reports with begin date on or after the given date.

reportDateBeginLt

Returns only reports with begin date before the the given date.

modifiedDateGte

Returns only reports that were generated on or after the given date. This parameter can be used to detect regenerated reports in case of data quality issues.


An unexpected error occurred. Please try again later.
Your session has expired

Please sign in to continue

Sign In
edit