Website logo
Dashboard
⌘K
🚀Integration Guide Overview
JS SDK (for Websites)
Presentation Options
Google Tag Manager (GTM)
Google Ad Manager (GAM)
Mobile SDK
iOS SDK
Android SDK
React Native SDK
Flutter SDK
Using macros
Passing payload values
Shopify
API
Native Ads API
Reporting API
Settings API
Errors
Postbacks
LoyaltyBoost (Rewarded Campaigns)
Perkswall
Frequently Asked Questions
Adding AdsPostX to your page
Offerwall
Docs powered by Archbee
API

Reporting API

The AdsPostX Reporting API allows publishers to programmatically retrieve statistics and activity related to their account.

Get reports for account
GET
Params
Query Parameters
api_key
required
String
Publisher api_key Required Permission: Reports
from
optional
String
From date (YYYY-MM-DD) default (first day of current month)
to
optional
String
To date (YYYY-MM-DD) default (current date)
aggregated_by
optional
String
Options: month, day, hour month = segment activity on a month basis day = segment activity on a day basis hour = segment activity on an hour basis default (day)
<string>
optional
String
Optional param(s) acting like a filter. Each parameter corresponds to a property in the session payload. The name of the parameter can be any name, not just "subId" For example, if the client sends a payload containing a property named "companyId" with a value of "123" and a property named "status" with a value of "approved", the API can retrieve activities only for sessions that contain a payload with companyId equal to "123" and status equal to "approved". To achieve this filtering, the client can send query parameters named "companyId" and "status" with their respective values.

Get reports for sub accounts
GET
Params
Query Parameters
api_key
required
String
Publisher api_key Required Permission: Account Management
accounts
required
Array
List of accountIds (Under your parent account) must have at least one id
from
optional
String
From date (YYYY-MM-DD) default (first day of current month)
to
optional
String
To date (YYYY-MM-DD) default (current date)
returnAvailableAccounts
optional
Boolean
A flag to return a list of available accounts ids under your parent account alongside with the response (availableIds) default(false)

Get reports for campaigns
GET
Params
Query Parameters
api_key
required
String
Publisher api_key Required Permission: Campaigns Management
campaigns
required
Array
List of campaignIds must have at least one id
from
optional
String
From date (YYYY-MM-DD) default (first day of current month)
to
optional
String
To date (YYYY-MM-DD) default (current date) * the maximum allowed date range is 29 days (to - from < 30 days).
returnAvailableCampaigns
optional
Boolean
A flag to return a list of available campaigns alongside with the response (availableIds) default:(false)




PREVIOUS
Anatomy of an Offer
NEXT
Settings API
Docs powered by Archbee