Advertiser Report

API Endpoints

List of Advertiser Report

Return list of Advertiser Report

GET https://api.tyrads.com/reports

Parameters:

Attribute	Type	Required	Description
from	string	yes	The start date of the report. Format: YYYY-MM-DD
to	string	yes	The end date of the report. Format: YYYY-MM-DD
app	string	no	List app package names separated by comma: com.some.app, com.other.app
columns	string	no	Addtional columns to the report

Example:

GEThttp://api.tyrads.com/reports

Query parameters

Response

200

Status OK

Body

application/json

datestring (date)

Example: "2022-10-31"

campaignIdstring

Example: "105"

externalCampaignNamestring

Example: "TA_EXAMPLE_CAMPAIGN_ID"

publisherIdstring

Example: "214"

appNamestring

Example: "Example App Name"

packageNamestring

Example: "app.test.com"

impressionsinteger (int32)

Example: 124

clicksinteger (int32)

Example: 43

installsinteger (int32)

Example: 10

costinteger (int32)

Example: 101

osstring

Example: "Android"

Request

JavaScriptCurlPython

const response = await fetch('http://api.tyrads.com/reports?from=2024-11-14&to=2024-11-14', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "date": "2022-10-31",
    "campaignId": "105",
    "externalCampaignName": "TA_EXAMPLE_CAMPAIGN_ID",
    "publisherId": "214",
    "appName": "Example App Name",
    "packageName": "app.test.com",
    "impressions": 124,
    "clicks": 43,
    "installs": 10,
    "cost": 101,
    "os": "Android"
  }
]

You can get reports for a specific application with app parameter query. Example URL:

https://api.tyrads.com/reports?from=2023-01-01&to=2023-03-03&app=app.test.com

You can have additional information with columns parameter query. Example URL:

https://api.tyrads.com/reports?from=2023-01-01&to=2023-03-03&app=app.test.com&columns=sourceId,subSourceId,creativeName

API References

Advertiser Report

Field	Type	Description
date	string	The date of the data given. Format: YYY-MM-DD
campaignId	string	The internal campaign ID used by the Tyrads system also passed to attribution tools
externalCampaignName	string	Campaign name used within the MMP
publisherId	string	The internal publisher ID of the Tyrads system that represents the publisher
appName	string	The app that is being promoted by the Tyrads system
packageName	string	The package name of the app that is being promoted by Tyrads system
impressions	integer	The amount of impressions or views
clicks	integer	The amount of clicks
installs	integer	The amount of installs delivered
cost	integer	The amount spent on the campaign
everflowId	string	The everflow offer id

Additional columns of Advertiser Report

Field	Type	Description
sourceId	string	The source of the publishers traffic
subSourceId	string	The sub source of the publishers traffic
creativeName	integer	The Creative name used
creativeId	integer	The Creative ID connected to the Creative used
creativeType	string	The type of Creative used
publisherCampaignId	integer	The campaign ID of the Publisher
publisherCampaignName	string	The campaign name used by the publisher
publisherCreativeId	integer	The Creative ID used by the publisher, incase the publisher uses a different creative ID format
publisherAppName	string	The appname of where the ads are shown
publisherPackageName	string	The packagename of where the ads are shown
publisherStoreCategory	string	The store category of the app where the ads are shown
publisherCategory	string	The iAB Category of the App where the ads are shown
publisherSubCategory	string	The iAB Sub Category of the App where the ads are shown
deviceType	string	The device type of the app
touchType	string	The type of attribution that resulted into the conversion, either view or click
Country	string	The country where the download came from, taken from the MMP
os	string	The operation system