Analytics

Generate a custom report with full access to all metrics and dimensions. Authentication: Required (Bearer Token) Role Required: Admin or Publisher

POST /api/reportv2/

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "dimensions": ["date", "publisher"],
  "metrics": ["impression", "revenue", "ecpm"],
  "filters": [
    {
      "key": "publisher",
      "value": "123",
      "operator": "="
    }
  ],
  "order": "revenue DESC",
  "limit": "100",
  "skip": "0",
  "csv": false,
  "totals": true
}

Pagination & Sorting Parameters

Parameter	Type	Default	Description
order	string	-	Sort order. Format: column [ASC|DESC]. Examples: "date", "revenue DESC", "impression
limit	string	-	Maximum number of rows to return. Example: "100"
skip	string	"0"	Number of rows to skip (for pagination). Example: "50" to get page 2 with limit 50

Pagination Example

// Page 1 (first 50 results)
{
  "limit": "50",
  "skip": "0",
  "order": "date DESC"
}

// Page 2 (next 50 results)
{
  "limit": "50",
  "skip": "50",
  "order": "date DESC"
}

// Page 3
{
  "limit": "50",
  "skip": "100",
  "order": "date DESC"
}

---

Output Format Parameters

Parameter	Type	Default	Description
csv	boolean	false	If true, returns CSV file download instead of JSON
totals	boolean	false	If true, includes a totals row as the first element in the response

CSV Response

When CSV: true, the response is a downloadable CSV file:

Request

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "dimensions": ["date"],
  "metrics": ["impression", "revenue"],
  "csv": true
}

Response Headers

Content-Type: text/csv
Content-Disposition: attachment; filename="report_2024-01-01.csv"

Response Body

date,impression,revenue
2024-01-01,50000,150.50
2024-01-02,48000,144.00
2024-01-03,52000,156.00

---

Totals Response

When totals: true, the first row contains aggregated totals across all data

Request

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-03",
  "dimensions": ["date"],
  "metrics": ["impression", "revenue"],
  "totals": true
}

Response

[
  {
    "date": "Total",
    "impression": 150000,
    "revenue": 450.50
  },
  {
    "date": "2024-01-01",
    "impression": 50000,
    "revenue": 150.50
  },
  {
    "date": "2024-01-02",
    "impression": 48000,
    "revenue": 144.00
  },
  {
    "date": "2024-01-03",
    "impression": 52000,
    "revenue": 156.00
  }
]

---

Complete Request Example

{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "dimensions": ["date", "country"],
  "metrics": ["impression", "revenue", "ecpm", "fillrate"],
  "filters": [
    {
      "key": "publisher",
      "value": "123",
      "operator": "="
    },
    {
      "key": "country",
      "values": ["US", "CA", "GB"],
      "operator": "IN"
    }
  ],
  "order": "revenue DESC",
  "limit": "100",
  "skip": "0",
  "csv": false,
  "totals": true
}

Response

[
  {
    "date": "Total",
    "country": "",
    "impression": 500000,
    "revenue": 1500.00,
    "ecpm": 3.00,
    "fillrate": 75.5
  },
  {
    "date": "2024-01-15",
    "country": "US",
    "impression": 25000,
    "revenue": 87.50,
    "ecpm": 3.50,
    "fillrate": 82.3
  },
  {
    "date": "2024-01-14",
    "country": "US",
    "impression": 24000,
    "revenue": 84.00,
    "ecpm": 3.50,
    "fillrate": 80.1
  }
]

---

Parameter Summary Table

Parameter	Type	Required	Default	Description
startDate	string		-	Start date (YYYY-MM-DD)
endDate	string		-	End date (YYYY-MM-DD)
dimensions	string[]		-	Grouping columns
metrics	string[]		-	Aggregation columns
filters	Filter[]		[]	Filter conditions
order	string		-	Sort column and direction
limit	string		-	Max rows to return
skip	string		"0"	Rows to skip (pagination)
csv	boolean		false	Return as CSV file
totals	boolean		false	Include totals row