Skip to main content
POST
/
advertisers
/
reporting
/
entity
Entity Reporting
curl --request POST \
  --url https://api.eflow.team/v1/advertisers/reporting/entity \
  --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,
        "cv": 123,
        "event": 123,
        "cvr": 123,
        "evr": 123,
        "ctr": 123,
        "cost": 123,
        "cpc": 123,
        "cpm": 123,
        "gross_sales": 123
      }
    }
  ],
  "performance": [
    {
      "unix": 123,
      "reporting": {
        "imp": 123,
        "total_click": 123,
        "unique_click": 123,
        "invalid_click": 123,
        "cv": 123,
        "event": 123,
        "cvr": 123,
        "evr": 123,
        "ctr": 123,
        "cost": 123,
        "cpc": 123,
        "cpm": 123,
        "gross_sales": 123
      }
    }
  ],
  "summary": {
    "imp": 123,
    "total_click": 123,
    "unique_click": 123,
    "invalid_click": 123,
    "cv": 123,
    "event": 123,
    "cvr": 123,
    "evr": 123,
    "ctr": 123,
    "cost": 123,
    "cpc": 123,
    "cpm": 123,
    "gross_sales": 123
  }
}
The main reporting endpoint for advertisers. Pivot your performance data by up to 10 dimensions over a date range. Returns table data, time-series performance, and an aggregated summary. Data is automatically scoped to the authenticated advertiser — no advertiser filter is needed. The API key determines which advertiser’s data is returned. Maximum reporting interval is one year (365 days). Results are limited to 10,000 rows.

Authorizations

​
X-Eflow-Api-Key
string
header
required

The advertiser's API key generated from the Advertiser Portal. Uses the same X-Eflow-Api-Key header as other Everflow APIs, but the key belongs to the advertiser 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 for filtering, metric filtering, and exclusions.

Response

200 - application/json
​
table
object[]

Array of reporting data rows grouped by the requested columns.

​
performance
object[]

Time-series performance data points.

​
summary
object

Aggregated summary across all rows. A flat object with the same metric keys as ReportingMetrics.