Get project status

GET

/v1/projects/{id}/status

• Web API (Projects, Maps, Content, Query, Analytics, Alerts, Data)

Returns the project details and key performance indicators (KPIs).

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Project UUID.

Query Parameters

fresh

integer

Allowed values: 1

Set to 1 to bypass the KPI cache and run a fresh query.

Responses

200

Project status and KPIs. kpis.fetchedAt is the Unix timestamp in milliseconds when the KPI snapshot was queried.

object

success

boolean

data

required

Project identity and current key performance indicators.

object

project

required

object

id

required

Project UUID.

string format: uuid

name

required

Human-readable project name.

string

kpis

required

object

dau

required

Daily active users.

integer

mau

required

Monthly active users.

integer

sessions

required

Session count for the current window.

integer

events

required

Event count for the current window.

integer

fetchedAt

required

Unix timestamp in milliseconds when the KPIs were computed.

integer format: int64

Example

{
  "success": true,
  "data": {
    "project": {
      "id": "3f1c2a9e-8b4d-4e6a-9c1f-2d7e5a0b8c34",
      "name": "My Game"
    },
    "kpis": {
      "dau": 1240,
      "mau": 18300,
      "sessions": 2450,
      "events": 984210,
      "fetchedAt": 1721563200000
    }
  }
}

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.

401

Missing or invalid API key.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

404

Resource not found.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

429

Rate limit exceeded.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

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.

Retry-After

integer

Number of seconds to wait before retrying. Present only on 429 responses. Because the limit uses a sliding window, honor this value per response rather than scheduling a retry for the reset time.