API Authentication

Requests to the Katalys API requires that you generate an API key for for your organization. The API key will have read/write access to your all data owned by your Organization.

An Organization owns one or more Profiles. Permissions are managed per-Organization.
A Profile owns one or more Programs and/or Traffic Sources. Profiles hold brand information like your profile, and your integrations which hold your data.

Generating an API Key

To generate an API key, login to your KMP account, click “Settings” in the main-navigation bar, and click “API Access”. Or use the link below.

Get your API key now →

Authenticating to the API

Once you have generated an API key, include that key within the Authorization header of every HTTP request you make to the Katalys API. The syntax for the Authorization header is apikey {your-api-key}.

An example API call might be:

CODE

curl -i -H 'Authorization: apikey 123456789abcdef@12345-6789-abcdef-abcdef' \
  -H 'Content-Type: application/json' \
  -d '{"dimensions": ["order_time", "order_id", "payout"], "filters": [ {"field":"time", "type":"range", "values":[12345, 12346] } ] }' \
  https://api.katalys.com/v1/report/conversions

Rate Limits

Your API key is limited to 30 requests per minute. If you exceed this, you will start receiving HTTP 429 responses, and you must pause usage of the key for a full minute before continuing to use your API key.