Skip to main content
POST
/
affiliates
/
reporting
/
entity
/
table
Get Aggregated Reporting Data
curl --request POST \
  --url https://api.eflow.team/v1/affiliates/reporting/entity/table \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "from": "2024-01-01",
  "to": "2024-01-31",
  "timezone_id": 67,
  "currency_id": "USD",
  "columns": [
    {
      "column": "offer"
    }
  ],
  "query": {
    "filters": []
  }
}
'
{
  "table": [
    {
      "columns": [
        {
          "column_type": "<string>",
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "reporting": {
        "imp": 123,
        "total_click": 123,
        "unique_click": 123,
        "invalid_click": 123,
        "duplicate_click": 123,
        "ctr": 123,
        "cv": 123,
        "view_through_cv": 123,
        "event": 123,
        "cvr": 123,
        "evr": 123,
        "rpc": 123,
        "rpm": 123,
        "revenue": 123,
        "redirect_traffic_revenue": 123
      }
    }
  ],
  "incomplete_results": true
}

Authorizations

X-Eflow-Api-Key
string
header
required

The affiliate's API key generated from the Affiliate Portal. Uses the same X-Eflow-Api-Key header as the Network API, but the key belongs to the affiliate user rather than the network admin.

Body

application/json
from
string
required

Start date for the reporting period. Format YYYY-MM-DD.

to
string
required

End date for the reporting period. Format YYYY-MM-DD.

timezone_id
integer
required

Timezone identifier for the request.

currency_id
string
required

Currency code for monetary values (e.g. "USD").

columns
object[]
required

Columns to group/pivot data by. Minimum 1, maximum 10. Only one time column (hour, date, week, month, year) is allowed per request.

Required array length: 1 - 10 elements
query
object

Query configuration.

Response

200 - application/json

OK

table
object[]

Array of reporting data rows.

incomplete_results
boolean

True if results exceeded the 10,000-row limit and were truncated.