コンテンツにスキップ

Get insights

GET
/v1/projects/{id}/insights

Returns aggregated analytics data grouped by a specified dimension. Useful for exploring event distributions, platform breakdowns, and time-series trends.

id
required
string format: uuid

Project UUID.

metric
required
string
Allowed values: count unique_players

Metric to aggregate.

groupBy
required
string
Allowed values: day week month event_name map_id platform build_id

Dimension to group results by.

days
integer
default: 30
Allowed values: 7 14 30 90

Time period in days.

limit
integer
default: 10
Allowed values: 10 20 50

Maximum number of groups to return.

eventName
string

Filter by event name.

Aggregated insights data.

object
success
boolean
data
object
rows
Array<object>
object
group

Dimension value (date, event name, map ID, etc.).

string
value
integer
total

Total value across all groups.

integer
distinctGroups

Total number of distinct groups (may exceed returned rows if limited).

integer
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.

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

Resource not found.

object
success
boolean
error

Human-readable error message.

string

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string
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.