TyrAds Docs
Official WebsiteSDK Integration
  • Welcome
  • Advertiser API
    • Overview
    • Authentication
    • API Resources
      • Advertiser Report
  • Publishers Integrations
    • Overview
    • Publisher API
      • Authentication
      • API Resources
        • Active Campaigns
        • Support Ticket
          • Iframe Publisher Support Tickets
      • Rate Limiting
    • Postback Macros
Powered by GitBook
On this page
  1. Advertiser API
  2. API Resources

Advertiser Report

PreviousAPI ResourcesNextOverview

Last updated 9 months ago

API Endpoints

List of Advertiser Report

Return list of

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

Example:

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

to the report

You can have with columns parameter query. Example URL:

additional information
Addtional columns
Advertiser Report
get
Query parameters
fromstring · dateRequired
tostring · dateRequired
appstringOptional
columnsstringOptional
Responses
200
Status OK
application/json
get
GET /reports HTTP/1.1
Host: api.tyrads.com
Accept: */*
200

Status OK

[
  {
    "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"
  }
]
  • API Endpoints
  • List of Advertiser Report
  • GET/reports
  • API References
  • Advertiser Report
  • Additional columns of Advertiser Report