Sovrn's Advertising Reporting API requires an API key to authenticate every request. You generate keys yourself from the Sovrn Platform, and only the account owner has permission to create or delete them.
Where do I create an API key?
-
Log in to the Sovrn Platform.
-
Open the Account menu and click API Keys.
-
Click the + API Key button in the top right corner.
-
Enter a name for the key and click Create.
-
Copy the generated key and save it somewhere secure.
You can only view the key value once. Once you close the window, the value is hidden permanently. If you lose it, you'll need to delete the key and create a new one.
Your key is a 7-character prefix followed by a . and a 32-character UUID — for example: 1234567.a34d7eb0-abfc-44fea-9fcc-7es42be45663.
Who can create and manage API keys?
Only the account owner can create or delete API keys. To find your account owner, open Manage users in the Sovrn Platform and look for the entry labeled "original user."
If you need to change the account owner, contact support.
How many API keys can I create?
There's no limit on the number of keys you can create. Every key grants the same level of access — full access to all Advertising reporting data associated with your Sovrn account.
How do I use the key to authenticate?
Pass the key in the request header using the key name x-api-key:
x-api-key: 1234567.a34d7eb0-abfc-44fea-9fcc-7es42be45663
For full details on building requests, available metrics and dimensions, and example calls, see How do I use the Sovrn Reporting API?
How do I quickly test that my key works?
Run this curl request, replacing the publisher ID, domain, and x-api-key value with your own:
curl --request GET \
--url 'https://api.sovrn.com/reporting/advertising/publishers/262681/domains/sovrntest.com/account?start=2024-08-01T00%3A00%3A00Z&end=2024-09-02T00%3A00%3A00Z&metrics=publisherRevenue&dimensions=domain&granularity=day' \
--header 'x-api-key: 1234567.a34d7eb0-abfc-44fea-9fcc-7es42be45663'
A successful response confirms your key is working.
How do I delete an API key?
-
Log in to the Sovrn Platform.
-
Open the Account menu and click API Keys.
-
Click the trashcan icon to the right of the key entry you want to remove.
Deleted keys stop working immediately. Any application using the deleted key will need to be updated with a new one.
Where can I find more information?
The full Reporting API reference, including all available endpoints, parameters, and response formats, lives in the Sovrn Developer Center.
Questions? Concerns? Our team would be more than happy to help. Reach out to our Support Team here.