Reporting API

Get all the reporting data from the monetization ad units you serve with Palmup, including multiple metrics such as revenue, impressions, clicks, and CPM.

get
Stats

https://share.palmup.io/v1/stats?
This endpoint allows you to get reporting data for a given app
Request
Response
Request
Headers
X-API-KEY
required
string
Publisher API Key for authentication
Query Parameters
app
required
integer
Application Key
startDate
required
string
YYYY-MM-DD (UTC Timezone)
endDate
optional
string
YYYY-MM-DD (UTC Timezone)
Response
200: OK
Reporting data successfully retrieved.
[
{
"adUnit": "adunit-12345",
"date": "2020-05-24",
"data": [
{
"requests": 1187468,
"served": 125502,
"servedRate": 0.11,
"impressions": 98624,
"showRate": 0.79,
"clicks": 350,
"revenue": 125.25,
"cpm": 1.27
}
]
},
{
"adUnit": "adunit-12345",
"date": "2020-05-25",
"data": [
{
"requests": 1075176,
"served": 157618,
"servedRate": 0.15,
"impressions": 123546,
"showRate": 0.78,
"clicks": 438,
"revenue": 164.32,
"cpm": 1.33
}
]
}
]
404: Not Found
Could not find data
This app ID is not known

Metrics

Description

requests

The total number of your app's requests that resulted in actual ad serving requests being sent.

served

The number of times an ad was served in response to a request from your app.

servedRate

The percentage of ad requests that were filled with an ad. This value is calculated using Served Requests / Requests.

Example: If an app's Served requests are equal to 40 and the total requests for the app is 50, then the app's Served rate will be 80%.

impressions

The total number of ads shown to users of an app.

showRate

Percentage of returned ads that were displayed in the app to the user. Calculated using Impressions / Served requests.

Example: If the total number of Served requests is 80, but your app only shows 60 of these, then the app's Show rate will be 75%.

clicks

The number of times a user clicks an ad.

revenue

Your earnings accrued so far, based on UTC. This amount is an estimate that is subject to change when your earnings are verified for accuracy at the end of every month.

cpm

An estimate of the revenue you receive for every thousand ad impressions. It is calculated as (Total Earnings / Impressions) x 1000.

Request Example URL

https://share.palmup.io/v1/stats?app=1&startDate=2020-05-23&endDate=2020-05-25

Find your Keys

You can find your unique parameters App Key & Publisher API Key under API Keys tab here: