Run a saved report

GET

/api/v1/analytics/reports/{id}/run

const url = 'https://example.com/api/v1/analytics/reports/example/run';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/analytics/reports/example/run \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

required

string

Saved report UUID

Responses

200

application/json

object

from

required

string

required

string

timezone

required

string

dateBasis

required

string

Allowed values: click conversion

groupBy

required

Array<string>

rows

required

Array<object>

object

dimensions

required

Keyed by the groupBy token that produced it, e.g. “country”, “sub_id:sub_id_2”

object

metrics

required

Keyed by metric name (base metrics + any customMetrics)

object

totals

required

Totals across the whole filtered date range, ignoring groupBy

object

costAttributed

required

Whether a manual cost_records lookup was possible for the requested groupBy (“link”, a single “sub_id:” and/or one date/week/month bucket; each record is spread evenly over the days of its period). Filters other than “link is one of…” also switch it off. cost/profit/roi/cpc/cpm are populated either way — manual entries win when present for a row, otherwise cost falls back to the sum of the automatic per-click cost model (click_events.cost).

boolean

comparison

object

from

required

string

required

string

metrics

required

Same metrics as totals, for the previous equal-length period

object

deltaPercent

required

(current - previous) / |previous| * 100, per metric. Null when not computable.

object

limit

required

number

offset

required

number

totalGroups

required

Total number of groups before limit/offset was applied

number

Example

{
  "dateBasis": "click"
}

404

Saved report not found