Adjoe SSP API User Ad Data Report Documentation Version 1.0

1. All publishers could request a SSP API Token to query user ad data reports.

  • Process outline

    Reports have to be received in two steps:

    1. A report URL is requested

    2. The report can be found by executing a GET request to the report URL

  • Availability

    Each day, the data for yesterday is available starting 14:00 UTC. Make sure to only call the API after 14:00 UTC each day. In addition he reports will only be available once the account manager has enabled the report. For example, if the account manager enabled the report on 2022-01-01 the report for 2022-01-01 would be available on 2022-01-02 14:00 UTC. There won't be any reports for dates before 2022-01-01.

1.1 Obtain Report URL

  • URL

    https://prod.adjoe.zone/v1/ssp-api/%TOKEN%/user-ad-data-report/app/%APP-ID%?date=2020-02-01

    %TOKEN%

    The token is a hex string, which is given to the publisher by the account manager.

    %APP-ID%

    Android package name | iOS Appstore ID for which to request the report.

  • Method:

    The http request type

    GET

  • URL Params

    Reports have to be queried by date. Only one date for one SDK token can be queried at a time

    Required:

    • date=[YYYY-MM-DD]

  • Success Response:

    On success the API responds with a http OK status code and a valid json object containing the report URL.

    • Code: 200

      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"
}

  • Error Response:

    The API does respond with different status codes, depending on the error:

    • Code: 401 UNAUTHORIZED

      If the authorization fails, the API returns status code 401 with error message.

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

      Content:

        {
      "error" : "invalid token"
  }

  • Sample Curl Call:

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

1.2 Obtain report

  • Execute a GET request to the ReportURL obtained in the previous step. This download the report file

  • Success Response:

    On success the API responds with a http OK status code and the CSV file. The file could be empty if no data is available.

    • Code: 200

      Content-Type: text/csv

      Content:

      • Example 1

        "2020-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 2

        "2020-02-01","9e304d4e8df1b74cfa009913198428ab","ios","1225867923","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

        Columnn Defintion The columns in the CSV file are

        • Date

        • SDK token

        • Platform, android|ios

        • Android Package name of the SDK app | iOS Appstore ID of the SDK app

        • 2 letter country code

        • Google Advertiser ID | IDFA

        • UserUUID used by adjoe to identify the user

        • ExternalUserID 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 in USD

        • Revenue in USD for this user on this date

        • ImpressionCount the number of impressions for this user on this date

Last updated

Was this helpful?