Report Endpoint

note: The {yourAgencyName} placeholder should be substituted with the subdomain of the URL you use to access the Affluent dashboard. For instance, if you log in at “dundermifflin.affluent.io” then you should replace {yourAgencyName} with “dundermifflin”

The Report endpoint allows you to query aggregated data in a completely customizable format. 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.

The JSON body requires:

1. A currency flag. All results will be converted into the specified currency. For example:

"currency": "USD"

2. A dates object that specifies the date range for which you would like to query data. All requests should be made using eventDateStart and eventDateEnd. Querying based on modified times is not supported in the Report endpoint. Note that these dates are requested in UTC time and the date range you specify can not be larger than 62 days.
3. A categories array. This should contain all the fields you would like to group by. For example the following array will return data grouped by date, publisher ID, and publisher name:

"categories": [ "date", "platformName", "publisherName", "publisherId" ]

• Supported Categories

4. A metrics array. This should contain all the metrics you would like. For example, the following array will return net revenue, net commissions, and clicks:

"metrics": [ "advertiserRevenueNet", "publisherCommissionNet", "clickCount" ]

• Supported Metrics

5. A limit and offset (see Limit and Offset)

The JSON body can additionally accept:

1. Filters
2. Sort