This topic walks through the steps on how to authenticate and use a reporting API to get the financial statements for the RAMP/Acadia account ID linked to your Slate account. If you still have questions after following these steps, please contact your vendor manager.
Prerequisite
You need a Prime Video Slate account to perform these steps.
- If you don’t have a Slate account yet, please go to slate.amazon.com and create an account. Then come back to this page and start from Step 1.
OR - If you are already onboarded to the existing Channels and TVOD legacy reports via the API, skip to Step 3.
Step 1: Get your Slate user code
- In Slate, click the Account settings dropdown in the upper right and select My user settings.
- Copy the User code shown, and provide it to your partner manager or vendor manager.
In this example, the user code is J7NY8HFT64. If you are having trouble with this step, click the Support dropdown and select Contact Support.
Step 2: Get authorized to call the Reporting API
To integrate your application with the Reporting API, you need to:
- Create a Login with Amazon Security Profile.
- Generate an authorization code to authorize the application.
- Request tokens.
For more details about working with APIs, see Prime Video Slate reporting APIs.
Step 4: Build the correct API URL
The general Reporting API URL is in the following format, where the content inside brackets {} varies from partner to partner:
https://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{report_identifier}/
reportTypes/{report_type_id}/reports
Each placeholder path parameter is defined below.
- account_id: The RAMP/Acadia account ID that is linked to your Slate account. Please ask your partner manager for this ID. If you are an existing legacy report user, this will remain unchanged.
- reports_group_id: This string is constant for any financial statement reports: financialStatement
report_identifier: This is set up by your partner manager or vendor manager. To get a list of which reports are available for your account, call the API URL https://videocentral.amazon.com/apis/v1/accounts/{account_id}/financialStatement
This will show you all of the report identifiers you have access to.- report_type_id: This is a fixed value, one of the following two options.
- For Channels: amzn1.vcpa.arcs.insight.286fd5d9-aeb3-4eb0-99a1-959225160a01
- For TVOD: amzn1.vcpa.arcs.insight.33ee837f-af47-40d6-8c2c-798eba24fac8
For more information about how the reporting API works, see Reporting API documentation.
Final API response
Once you have the correct API URL and your partner manager has surfaced the right reports for you, this is the resulting API response. (The following screenshot is from a test account’s API URL.)
The API URL used to get this result looks like this:
https://videocentral.amazon.com/apis/v1/accounts/{partner’s acadia account ID}/financialstatement/{report_identifier}/reportTypes/{report_type_id}/reports
The downloadUrl shown in the API response is a presigned URL that allows you to download the report. The modifiedDate shown in the API response is the time when the data was refreshed for a particular report.
The API URL will get you all the reports available for your Slate account. To look at specific months, you can use the API request parameters reportDateBeginGte and reportDateBeginLt to specify the time range.
For example, to get specific reporting for October 2024, set the reportDateBeginGte to 2024-10-01 and the reportDateBeginLt to 2024-11-01.
For more information, see Reporting API documentation.