API Reference

Get Chart builder data

get
https://api.web2wave.com/api/reports/chart-builder

Returns the same chart data as the cabinet "Chart builder" (labels + datasets),
scoped to the project of the API key. Use GET /reports/chart-builder/catalog
to discover valid metric, x_axis and series ids.
from/to are interpreted in the project timezone; defaults to the last 30 days.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Metric id from catalog.builder_metrics.

string
Defaults to day

Dimension id from catalog.dimensions for the X axis.

string
Defaults to none

Dimension id to break the chart into series, or none. Ignored when equal to x_axis.

string
enum
Defaults to value

Sort order key.

Allowed:
string
enum
Defaults to desc

Sort direction.

Allowed:
string
enum

Filter rows by metric value together with y_value.

Allowed:
number

Metric value threshold for y_operator.

date

Start date (YYYY-MM-DD, project timezone). Defaults to 29 days ago.

date

End date (YYYY-MM-DD, project timezone). Defaults to today.

quizzes

Limit to quiz ids.

paywalls

Limit to paywall ids.

utm_source

Filter by utm_source values.

utm_medium

Filter by utm_medium values.

utm_campaign

Filter by utm_campaign values.

utm_content

Filter by utm_content values.

utm_term

Filter by utm_term values.

integer

Filter by payment system id.

string

Filter by user country code.

string

Filter by user platform.

integer

Filter by experiment id.

integer

Experiment variant (used with experiment_id, default 0).

string

User property name to filter by (with user_property_value).

string

User property value.

Headers
string
required

API key for authentication

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?