Get dashboard metrics

GET

/v1/projects/{id}/dashboard

• Web API (Projects, Maps, Content, Query)

Returns dashboard KPIs, daily active user time series, and top events for the specified project and time period.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Project UUID.

Query Parameters

days

integer

default: 30

Allowed values: 7 14 30 90

Time period in days.

Responses

200

Dashboard metrics.

object

success

boolean

data

object

kpis

Key performance indicators for the project dashboard.

object

dau

Daily active unique players.

integer

mau

Monthly active unique players.

integer

sessions

Total sessions in the period.

integer

events

Total events in the period.

integer

fetchedAt

Unix timestamp (ms) when the ClickHouse query executed.

number

dailyActiveUsers

Array<object>

object

date

Date in YYYY-MM-DD format.

string

Example

2024-01-15

count

integer

topEvents

Array<object>

object

event_name

string

count

integer

Headers

X-RateLimit-Limit

integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining

integer

Number of requests remaining in the current window.

X-RateLimit-Reset

integer

Unix timestamp when the rate limit window resets.

400

Invalid request parameters or body.

object

success

boolean

error

Human-readable error message.

string

401

Missing or invalid API key.

object

success

boolean

error

Human-readable error message.

string

404

Resource not found.

object

success

boolean

error

Human-readable error message.

string

429

Rate limit exceeded.

object

success

boolean

error

Human-readable error message.

string

Headers

X-RateLimit-Limit

integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining

integer

Number of requests remaining in the current window.

X-RateLimit-Reset

integer

Unix timestamp when the rate limit window resets.