User Ad Data Report API

The adjoe User Ad Data Report API allows publishers to request user data reports. The required parameter for using this API is the SSP API Token, which you can obtain from your adjoe Account Manager.

There are two steps to using the User Ad Data Report API:

1. Get the Report URL: Use your SSP API Token and Date to request a URL.

2. Download the Report: Access the URL to obtain your report.

Step 1: Obtain the Report URL

GET https://prod.adjoe.zone/v1/ssp-api/<your_token>/user-ad-data-report/app/<your_app_id>?date=[YYYY-MM-DD]

Required values:

<your_token> - 32-character hex string provided by the adjoe Account Manager.

<your_app_id> - Android package name or iOS Appstore ID. Example: com.king.candycrush

Query Parameters

Name	Type	Description
date*	date	Reports are queried by date, with only one date allowed per SDK token query. Format:[YYYY-MM-DD]

200

Response: OK, Returns a JSON object with the report URL

Content-Type: application/json; charset=utf-8

Content: {"ReportURL": "https://prod-adjoe-user-ad-data.s3.eu-central-1.amazonaws.com/acbd18db4cc2f85cedef654fccc4a4d8/2020-02-01_6f2fb2d3def4f99053edab239195f146.csv"}

401

Response: Unauthorized "Invalid Token"

Content-Type: application/json; charset=utf-8

Content: {"error" : "invalid token"}

Example Request

curl -X GET
'https://prod.adjoe.zone/v1/ssp-api/acbd18db4cc2f85cedef654fccc4a4d8/user-ad-data-report/app/com.king.candycrush4?date=2024-02-01'

---

Step 2: Obtain the Report

After obtaining the URL, download the report in CSV format. A successful download will prompt an HTTP 200: OK status, along with the CSV file. An empty file indicates no data is available yet.

Example Report 1:

"2024-02-01","6f2fb2d3def4f99053edab239195f146","android","com.king.candycrush4","DE","3d497f11-4e04-469c-821a-1f57429efb1a","0ca80a38-bb08-4365-8887-5014bf25373b","1ba8e52e-a967-422c-b67e-528511b9780b","Placement one","Home Screen",0.000,0.000,7

Example Report 2:

"2024-02-01","9e304d4e8df1b74cfa009913198428ab","ios","1225867923","DE","3d49"

Schema Definition

Value	Explanation
Date	Date
SDK Hash	The unique identifier to the SDK.
Platform	Android or iOS.
Package Name	Either the Android Package name or the iOS App Store ID of the SDK app.
Country Code	2-letter country code. Example: de, us, fr.
Google Advertiser ID | IDFA	A Google Advertising ID, also known as an Android ID, Android Device ID, or Android Advertising ID (AAID), is Google’s unique device identifier. The IDFA (identifier for advertisers) is a random iOS device identifier given by Apple.
UserUUID	Used by adjoe to identify the user.
External User ID	Used by the publisher to identify the user.
SDKSubID1	Sub ID 1 set in the SDK.
SDKSubID2	Sub ID 2 set in the SDK.
eCPM	Effective Cost Per Mille in USD.
Revenue	Revenue in USD for this user on this date.
Impression Count	The number of impressions for this user on this date.

Availability

Data is available daily from 2:00 UTC, covering the previous day's activities. To ensure successful API queries, initiate calls after 2:00 UTC. Access to reports is granted after your Account Manager has authorized them. For example, if your report is enabled on 2024-01-01, you can access it from 2:00 UTC on 2024-01-02. Note: Reports for periods before the enablement date, such as before 2024-01-01, are not accessible.