POST api/reports/getoffersreport
Request Information
URI Parameters
None.
Body Parameters
GetOffersReportRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| OfferIDs | Collection of integer |
None. |
|
| PartnerIDs | Collection of integer |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| Header | RequestHeader |
None. |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2026-01-13T10:23:56.2353921+05:30",
"EndDate": "2026-01-13T10:23:56.2353921+05:30",
"OfferIDs": [
1,
2
],
"PartnerIDs": [
1,
2
],
"PageNumber": 1,
"PageSize": 2,
"Header": {
"Token": "sample string 1",
"IPAddress": "sample string 2"
}
}
application/xml, text/xml
Sample:
<GetOffersReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADAnalytics.Entities.Reports.Integration">
<Header xmlns="http://schemas.datacontract.org/2004/07/ADAnalytics.Entities.Integration">
<IPAddress>sample string 2</IPAddress>
<Token>sample string 1</Token>
</Header>
<EndDate>2026-01-13T10:23:56.2353921+05:30</EndDate>
<OfferIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</OfferIDs>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<PartnerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</PartnerIDs>
<StartDate>2026-01-13T10:23:56.2353921+05:30</StartDate>
</GetOffersReportRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetOffersReportResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRecords | integer |
None. |
|
| ReportData | Collection of OffersReportItem |
None. |
|
| Result | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalRecords": 1,
"ReportData": [
{
"Period": "sample string 1",
"OfferID": 2,
"OfferName": "sample string 3",
"PartnerID": 4,
"PartnerName": "sample string 5",
"Clicks": 6,
"Installs": 7,
"Conversions": 8,
"ConversionRate": 9.0,
"InstallConversionCR": 10.0,
"TotalCost": 11.0,
"TotalRevenue": 12.0
},
{
"Period": "sample string 1",
"OfferID": 2,
"OfferName": "sample string 3",
"PartnerID": 4,
"PartnerName": "sample string 5",
"Clicks": 6,
"Installs": 7,
"Conversions": 8,
"ConversionRate": 9.0,
"InstallConversionCR": 10.0,
"TotalCost": 11.0,
"TotalRevenue": 12.0
}
],
"Result": {
"Result": 1,
"Messages": [
"sample string 1",
"sample string 2"
],
"TechnicalMessages": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<GetOffersReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADAnalytics.Entities.Reports.Integration">
<Result xmlns="http://schemas.datacontract.org/2004/07/ADAnalytics.Entities.Integration">
<Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Messages>
<Result>1</Result>
<TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</TechnicalMessages>
</Result>
<ReportData xmlns:d2p1="http://schemas.datacontract.org/2004/07/ADAnalytics.Entities.Reports">
<d2p1:OffersReportItem>
<d2p1:Clicks>6</d2p1:Clicks>
<d2p1:ConversionRate>9</d2p1:ConversionRate>
<d2p1:Conversions>8</d2p1:Conversions>
<d2p1:InstallConversionCR>10</d2p1:InstallConversionCR>
<d2p1:Installs>7</d2p1:Installs>
<d2p1:OfferID>2</d2p1:OfferID>
<d2p1:OfferName>sample string 3</d2p1:OfferName>
<d2p1:PartnerID>4</d2p1:PartnerID>
<d2p1:PartnerName>sample string 5</d2p1:PartnerName>
<d2p1:Period>sample string 1</d2p1:Period>
<d2p1:TotalCost>11</d2p1:TotalCost>
<d2p1:TotalRevenue>12</d2p1:TotalRevenue>
</d2p1:OffersReportItem>
<d2p1:OffersReportItem>
<d2p1:Clicks>6</d2p1:Clicks>
<d2p1:ConversionRate>9</d2p1:ConversionRate>
<d2p1:Conversions>8</d2p1:Conversions>
<d2p1:InstallConversionCR>10</d2p1:InstallConversionCR>
<d2p1:Installs>7</d2p1:Installs>
<d2p1:OfferID>2</d2p1:OfferID>
<d2p1:OfferName>sample string 3</d2p1:OfferName>
<d2p1:PartnerID>4</d2p1:PartnerID>
<d2p1:PartnerName>sample string 5</d2p1:PartnerName>
<d2p1:Period>sample string 1</d2p1:Period>
<d2p1:TotalCost>11</d2p1:TotalCost>
<d2p1:TotalRevenue>12</d2p1:TotalRevenue>
</d2p1:OffersReportItem>
</ReportData>
<TotalRecords>1</TotalRecords>
</GetOffersReportResponse>