Agency API

The Affluent Agency API allows you to query your data to obtain standardized data from  any number of brands and platforms. The API is organized around REST. It has predictable resource-oriented URLs, accepts JSON request bodies via POST requests, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The API currently has two endpoints:

  1. The Actions endpoint allows you to pull a list of every unique commissionable action (e.g. sales, leads, bonuses, etc) with all associated data Affluent has on that transaction including SKU data. Importantly, if you're maintaining your own data store, this API allows you to pull actions based on the last time they were modified so that you do not need to perform historical data pulls in order to update pending transactions.

  2. The Report endpoint allows you to query data in a completely customizable format - think Custom Reports in the Affluent UI. While common use cases might include pulling revenue, commission, and clicks by date, publisher, or brand, you can create literally any report using this endpoint.

For more details on how to use the API, please see our current documentation. Note that as we get closer to a general release, this documentation will be upgraded and moved to a standardized API format.