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 api docid\ fdwu3w abztbbfv5jhhqk 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 required should be application/json string application/json query parameters parameter description type example api key required required your api key api docid\ fdwu3w abztbbfv5jhhqk 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 activity an array of objects representing the activity data for each session it has the following attributes 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 { "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" } hourly granularity { "data" { "activity" \[ { "clicks" 0, "revenue" 0, "date" "2024 03 20t00 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t01 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t02 00 00+05 30", "impressions" 2, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t03 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t04 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t05 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t06 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t07 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t08 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t09 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t10 00 00+05 30", "impressions" 5, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t11 00 00+05 30", "impressions" 23, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t12 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t13 00 00+05 30", "impressions" 1, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t14 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t15 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t16 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t17 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t18 00 00+05 30", "impressions" 4, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t19 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t20 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t21 00 00+05 30", "impressions" 0, "rpm" 0, "ctr" 0 }, { "clicks" 1, "revenue" 0 02, "date" "2024 03 20t22 00 00+05 30", "impressions" 19, "rpm" 1 05, "ctr" 5 26 }, { "clicks" 0, "revenue" 0, "date" "2024 03 20t23 00 00+05 30", "impressions" 2, "rpm" 0, "ctr" 0 } ] }, "status" "success" } need some assistance? 📢 if you're running into any issues while going through the integration process, feel free to contact us at help\@adspostx com