Campaign Performance

Campaign Performance API

Use this API to retrieve aggregated statistics of your Campaign in the Nefta AdNetwork.

Authorisation

To access the app revenue reporting API, authorisation is required. Authorisation is in the form of an API key and is present in every API request in the Authorization header. Please contact your Nefta account manager to generate an API key for you.

The campaign performance API is accessed via HTTPS POST requests.

$ curl -X POST \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '$REQUEST_BODY' \
https://api.nefta.io/v1.4/reporting/campaigns

Request body

The revenue reporting API uses request body parameters to filter your request. Please note, certain parameters are required and others aren't.

from_date (Required): The starting date for your report data in YYYY-MM-DD format.

to_date (Required): The ending date for your report data in YYYY-MM-DD format.

Please note, the date range cannot exceed 31 days.

metrics (Required): A list of metrics you want to include in the report. Supported metrics are:

spend
impressions
clicks
installs

dimensions (Optional): A list of dimensions you want your data grouped by. Supported dimensions are:

date
campaign_id
creative_id
sdk_version
platform
ad_format
country
app_store
campaign_name
campaign_type
campaign_status
creative_name
creative_content_type

Request Body Example

The following snippet is an example of a request body.

{
  "from_date": "2024-10-31",
  "to_date": "2024-11-01",
  "dimensions": [
    "ad_format",
    "platform"
  ],
  "metrics": [
    "spend",
    "impressions",
    "clicks"
  ]
}

This example retrieves data for spend, impressions, and clicks for the period of October 31st, 2024 to November 1st, 2024, grouped by ad format and platform.

Response

The campaign performance AP returns data in the JSON format. The data is an array of JSON objects, as shown below.

[
    {
        "ad_format": "rewarded",
        "platform": "android",
        "spend": 68.302,
        "impressions": 1085,
        "clicks": 571
    },
    {
        "ad_format": "banner",
        "platform": "ios",
        "spend": 20.8581,
        "impressions": 25846,
        "clicks": 49
    },
    {
        "ad_format": "interstitial",
        "platform": "ios",
        "spend": 214.362,
        "impressions": 4218,
        "clicks": 867
    }
]

Please note, the currency of spend is always USD.