API

Reporting API

﻿
This API gives publishers the power to access 24-hour detailed insights into their accounts in a way that's easy to use and understand. Here's how it helps:
Retrieve performance reports: Access performance reports that include key metrics such as revenue, impressions, clicks, and click-through rate (CTR) for a specified date.
Customize data segmentation: Choose between daily or hourly segmentation options to analyze activity based on specific time intervals.
Apply filters: Use optional parameters to filter data based on properties passed in the payload when an AdsPostX experience was served. This enables publishers to focus on specific segments of their activity data.
Quickstart
﻿Obtain your API Key﻿﻿
Make a Fetch Reporting API call to AdsPostX to retrieve statistics related to your account.
Parse the response and display statistics in the desired fashion.
Fetching Performance Reports
HTTP Method:  GET
Base URL: https://api.adspostx.com/native/activity.json
Header Parameters
Parameter
Description
Type
Example
Content-Type
required﻿
Should be application/json
string
application/json
Query Parameters
Parameter
Description
Type
Example
api_key
required﻿
Your API Key. Obtain your API Key﻿
Required Permission: Reports
String
4bbdefc2-b130-424d-8170-54bdcb98e64e
from
Optional
Specify the date (YYYY-MM-DD format) for which you want to retrieve reports. 
It will retrieve data for only 24 hours starting from the specified date's beginning.
Default: Yesterday's Date (beginning of the day)
String
2024-03-20
aggregated_by
Optional
Choose between 'day' or 'hour' to segment activity on a daily or hourly basis. 
Default: 'day'.
String
hour
<string>
Optional
Filters data based on specific properties passed in the payload during an AdsPostX experience. For example, filtering by "companyId" with a value of "123" and "state" with a value of "approved" retrieves activities for sessions with companyId equal to "123" and state equal to "approved".
String
﻿state=approved
The from parameter in the query parameters is based on the publisher's timezone. It's important to ensure that these dates align with your local timezone settings to ensure accurate reporting data.

Response Body
When the "from" parameter is not specified, the API automatically retrieves data starting from the beginning of yesterday (in the publisher's timezone) until the current time today (also in the publisher's timezone). This timeframe is limited to 24 hours
Response Parameters
Upon making an API call, the following attributes are returned.
data object of activity data
Contains the activity array and response status
﻿
clicks integer 
This simply counts how many times customers interact with an Offer. This could be by clicking on a button, image, or even directly accessing an Offer link in their browser.
﻿
revenue  double
The revenue generated through customer engagement with AdsPostX Offers. 
﻿
impressions integer
This counts how many times Offers were requested. In other words, it tracks the number of times a set of Offers was presented to the customer.
﻿
rpm double
RPM measures the revenue earned for every 1000 impressions generated by AdsPostX. The formula to calculate RPM is: (Revenue / Impressions) x 1000.
﻿
 ctr double
CTR is a measure of how often people click on an Offer after seeing it. It's calculated as a percentage by dividing the number of clicks by the number of impressions.
﻿
date  date
This field indicates the date and time when the ad session started, presented in the format: "YYYY-MM-DDTHH:MM:SS+HH:MM".
For daily granularity: the date would represent the start of a day, such as "2024-03-20T00:00:00+05:30". In this case, it shows the date with no specific time, indicating the entire day's ad session.
For hourly granularity: the date would include the specific hour and minute when the ad session began, such as "2024-03-20T15:30:00+05:30". Here, the date includes both the date and the exact time when the ad session started.
﻿Sample Response﻿
Daily Granularity
Hourly Granularity
{
  "data": {
    "activity": [
       {
        "clicks": 1,
        "revenue": 0.02,
        "date": "2024-03-20T00:00:00+05:30",
        "impressions": 56,
        "rpm": 0.36,
        "ctr": 1.79
      }
    ]
  },
  "status": "success"
}
{
  "data": {
    "activity": [
       {
        "clicks": 1,
        "revenue": 0.02,
        "date": "2024-03-20T00:00:00+05:30",
        "impressions": 56,
        "rpm": 0.36,
        "ctr": 1.79
      }
    ]
  },
  "status": "success"
}
﻿
﻿
Need Some Assistance?
📢 If you're running into any issues while going through the integration process, feel free to contact us at [email protected].

Parameter	Description	Type	Example
Content-Type required	Should be application/json	string	application/json

Parameter	Description	Type	Example
api_key required	Your API Key. Obtain your API Key Required Permission: Reports	String	4bbdefc2-b130-424d-8170-54bdcb98e64e
from Optional	Specify the date (YYYY-MM-DD format) for which you want to retrieve reports. It will retrieve data for only 24 hours starting from the specified date's beginning. Default: Yesterday's Date (beginning of the day)	String	2024-03-20
aggregated_by Optional	Choose between 'day' or 'hour' to segment activity on a daily or hourly basis. Default: 'day'.	String	hour
<string> Optional	Filters data based on specific properties passed in the payload during an AdsPostX experience. For example, filtering by "companyId" with a value of "123" and "state" with a value of "approved" retrieves activities for sessions with companyId equal to "123" and state equal to "approved".	String	state=approved

Offer Catalog API

Errors

Reporting API

Quickstart

Fetching Performance Reports

Header Parameters

Query Parameters

Response Body

Response Parameters

﻿Sample Response﻿

Need Some Assistance?

Sample Response