# API de Relatórios

```
GET https://api.offer18.com/api/af/report
```

:link: [<mark style="color:blue;">**Click to Test Reports API**</mark> ](https://offer18.readme.io/reference/reports-api-1)

### Common Parameters <a href="#parameters" id="parameters"></a>

| **Query** | **Type** | **Description**     |
| --------- | -------- | ------------------- |
| mid       | Integer  | Your Advertiser MID |
| aid       | Integer  | Affiliate ID        |
| key       | String   | API Key             |

***

### Filters

<table data-header-hidden><thead><tr><th width="150">Query</th><th width="150"> </th><th width="368.2"> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>date_from</td><td>Date</td><td>Report Start Date (YYYY-MM-DD)</td></tr><tr><td>date_end</td><td>Date</td><td>Report End Date (YYYY-MM-DD)</td></tr><tr><td>datetime_from</td><td>Datetime</td><td>Report Start Date &#x26; Time (YYYY-MM-DD hh:mm:ss)</td></tr><tr><td>datetime_end</td><td>Datetime</td><td>Report End Date &#x26; Time (YYYY-MM-DD hh:mm:ss)</td></tr><tr><td>results</td><td>String</td><td>No. of results</td></tr><tr><td>page</td><td>Integer</td><td>Page No. (Starts from zero)</td></tr><tr><td>timezone</td><td>Decimal</td><td>Default 0.0 UTC</td></tr><tr><td>offer</td><td>String</td><td>Offer ID</td></tr><tr><td>report_type</td><td>String</td><td><strong>Allowed values:</strong><br>click, conversion, imps</td></tr><tr><td>aff_sub1</td><td>String</td><td>First Sub Affiliate ID (Affiliate Data)</td></tr><tr><td>aff_sub2</td><td>String</td><td>Second Sub Affiliate ID (Affiliate Data)</td></tr><tr><td>aff_sub3</td><td>String</td><td>Third Sub Affiliate ID (Affiliate Data)</td></tr><tr><td>aff_sub4</td><td>String</td><td>Fourth Sub Affiliate ID (Affiliate Data)</td></tr><tr><td>aff_sub5</td><td>String</td><td>Fifth Sub Affiliate ID (Affiliate Data)</td></tr></tbody></table>

```
https://api.offer18.com/api/af/report?key=000000000&aid=0000&mid=0000
```

#### Specify fields to view

<table data-header-hidden><thead><tr><th width="150">Query</th><th width="150"> </th><th width="424.20000000000005"> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>fields</td><td>String</td><td><p><strong>Allowed values:</strong></p><p>clicks, conversion, affiliate_price, date, time, hour, offer, offer_name, s_affiliate, event, impressions, unique_clicks, affiliate_model, ip, currency, isp, country, conn_speed, location, browser, os, os_ver, device, device_brand, device_model, referral_domain, useragent, referral_url, aff_click_id, aff_sub1, aff_sub2, aff_sub3, aff_sub4, aff_sub5, adv_sub4, adv_sub5, aff_sub6, aff_sub7, aff_sub8, aff_sub9, aff_sub10, ios_idfa, source, google_aid, android_id, device_id, cr, ctr, cpc, ecpm, e_cost_per_conversion, cr_unique, coupon</p></td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/report?key=000000000&aid=0000&mid=0000&fields=clicks,conversion,affiliate_price,date,time,hour,offer,offer_name,s_affiliate,event,impressions,unique_clicks,affiliate_model,ip,currency,isp,country,conn_speed,location,browser,os,os_ver,device,device_brand,device_model,referral_domain,useragent,referral_url,aff_click_id,aff_sub1,aff_sub2,aff_sub3,aff_sub4,aff_sub5,aff_sub6,aff_sub7,aff_sub8,aff_sub9,aff_sub10,adv_sub4,adv_sub5,ios_idfa,source,google_aid,android_id,device_id,cr,ctr,cpc,ecpm,e_cost_per_conversion,cr_unique,coupon
```

{% endcode %}

#### Additional Sorting Method

<table data-header-hidden><thead><tr><th width="150">Query</th><th width="150"> </th><th width="388"> </th></tr></thead><tbody><tr><td><strong>Query</strong></td><td><strong>Type</strong></td><td><strong>Description</strong></td></tr><tr><td>sort_by</td><td>String</td><td><strong>Allowed values:</strong> clicks, unique_clicks, conversions, date, time, hour<br>(Only one option is allowed to use) </td></tr><tr><td>sort_type</td><td>String</td><td><strong>Allowed values:</strong> asc and desc</td></tr></tbody></table>

{% code overflow="wrap" %}

```
https://api.offer18.com/api/af/report?key=000000000&aid=0000&mid=0000&sort_by=000000&sort_type=0000
```

{% endcode %}

***

### Example API Request

![](https://4294454144-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2FZti2IGSBlAmtmfoDZ7nT%2Fimage.png?alt=media\&token=b288cac0-a1aa-47fe-8f9e-d7ef8edd25e1)

***

### **API Response**

```
{
	"status": 200,
	"records": 3,
	"timezone": "+5:30",
	"reports": [
	{
		"Date": "2021-09-09",
		"Time": "2021-09-09 17:16:24",
		"Hour": "2021-09-09 17:00",
		"OfferID": "0001",
		"Sub_Affiliate": "",
		"Event": "",
		"Impressions": 0,
		"Clicks": 8,
		"UniqueClicks": 0,
		"Conversions": 0,
		"Affiliate_Model": "CPA",
		"Affiliate_Price": 0,
		"IP": "1.1.1.1",
		"Currency": "USD",
		"ISP": "Mountain_View_Communications",
		"Country": "AU",
		"Connection_Speed": "cable_dsl",
		"Location": "Australia, Oceania",
		"Browser": "ch",
		"OS": "windows",
		"OSver": 10,
		"Device": "desktop",
		"Device_Brand": "Lenovo",
		"Device_Model": "ideapad-x310s-ua",
		"Referral_Domain": "",
		"UserAgent": "Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F93.0.4577.63+Safari%2F537.36",
		"Referral_URL": "",
		"Aff_Click_ID": "",
		"Aff_Sub_1": "",
		"Aff_Sub_2": "",
		"Aff_Sub_3": "",
		"Aff_Sub_4": "",
		"Aff_Sub_5": "",
		"Adv_Sub_4": "",
		"Adv_Sub_5": "",
		"iOS_IDFA": "",
		"Source": "",
		"Google_AID": "",
		"Android_ID": "",
		"Device_ID": ""
	},	
	]
}
```