> For the complete documentation index, see [llms.txt](https://docs.tyrads.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tyrads.com/advertiser-api/api-resources/advertiser-report.md).

# Advertiser Report

## API Endpoints

### List of Advertiser Report

Return list of [Advertiser Report](#a-dvertiser-report)

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

**Parameters:**

<table><thead><tr><th width="138">Attribute</th><th width="99">Type</th><th width="102">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>from</code></td><td>string</td><td>yes</td><td>The start date of the report. Format: <code>YYYY-MM-DD</code></td></tr><tr><td><code>to</code></td><td>string</td><td>yes</td><td>The end date of the report. Format: <code>YYYY-MM-DD</code></td></tr><tr><td><code>app</code></td><td>string</td><td>no</td><td>List app package names separated by comma: <code>com.some.app, com.other.app</code></td></tr><tr><td><code>columns</code></td><td>string</td><td>no</td><td><a href="#additional-columns-of-a-dvertiser-report">Addtional columns</a> to the report</td></tr></tbody></table>

**Example:**

{% openapi src="/files/o2ffIpQ3U7W1IseZgzuK" path="/reports" method="get" %}
[advertiser-api.yml](https://2066086824-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjxRWBSTcObUX1TCoTG61%2Fuploads%2FDe7Qy2zEqfYTPZ64VG7C%2Fadvertiser-api.yml?alt=media\&token=50830b16-d8a8-47a0-aa0b-e53bf3b44128)
{% endopenapi %}

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](#additional-columns-of-a-dvertiser-report) with `columns` parameter query. Example URL:

{% code overflow="wrap" %}

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

{% endcode %}

##

## API References

### Advertiser Report

<table><thead><tr><th width="275">Field</th><th width="102.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code></td><td>string</td><td>The date of the data given. Format: <code>YYY-MM-DD</code></td></tr><tr><td><code>campaignId</code></td><td>string</td><td>The internal campaign ID used by the Tyrads system also passed to attribution tools</td></tr><tr><td><code>externalCampaignName</code></td><td>string</td><td>Campaign name used within the MMP</td></tr><tr><td><code>publisherId</code></td><td>string</td><td>The internal publisher ID of the Tyrads system that represents the publisher</td></tr><tr><td><code>appName</code></td><td>string</td><td>The app that is being promoted by the Tyrads system</td></tr><tr><td><code>packageName</code></td><td>string</td><td>The package name of the app that is being promoted by Tyrads system</td></tr><tr><td><code>impressions</code></td><td>integer</td><td>The amount of impressions or views</td></tr><tr><td><code>clicks</code></td><td>integer</td><td>The amount of clicks</td></tr><tr><td><code>installs</code></td><td>integer</td><td>The amount of installs delivered</td></tr><tr><td><code>cost</code></td><td>float</td><td>The amount spent on the campaign</td></tr><tr><td><code>everflowId</code></td><td>string</td><td>The everflow offer id</td></tr></tbody></table>

### Additional columns of Advertiser Report

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