Skip to main content
POST
Get network summary

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Query Parameters

currency
string

Currency code used to convert monetary values in the widget response.

Body

application/json
rangeFrom
string

Date range start (YYYY-MM-DD).

rangeTo
string

Date range end (YYYY-MM-DD).

breakdown
string

Breakdown type: hour, day, month, year.

breakdowns
string

Breakdown types (comma-separated).

columns
string

Requested metrics (comma-separated, e.g. clicks,cv_total,tr,total_payout).

preset
string

Time preset: today, yesterday, last7Days, last14Days, last30Days, thisMonth, lastMonth, thisYear, lastYear, allTime, custom.

filters
object

Filter criteria.

reportType
string

Report type (e.g. general, operator, broker).

Response

Network summary.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object[]