Skip to main content
POST
/
analytics
/
dashboard
Get dashboard analytics
curl --request POST \
  --url https://api.bitgpt.xyz/analytics/dashboard \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "period": "last_day"
}
'
{
  "status": 200,
  "data": {
    "id": "123"
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

Authorizations

​
Authorization
string
header
required

Send your access token as header Authorization: Bearer {accessToken}

​
Authorization
string
header
required

Your API key that starts with sk_live or sk_test. You can create yours at go.bitgpt.xyz/api-keys.

Body

application/json
​
period
enum<string>

Analytics period

Available options:
last_day,
last_7_days,
last_30_days,
last_90_days,
last_365_days,
prev_last_day,
prev_last_7_days,
prev_last_30_days,
prev_last_90_days,
prev_last_365_days
Example:

"last_7_days"

Response

Dashboard analytics data

​
status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
​
data
object
required

Response data containing the requested object

​
message
string | null
required

Message of the response, human readable

Example:

"Resource created successfully"

​
env
enum<string>
required

API environment

Available options:
development,
production
​
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

​
log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

​
validator
object

Validator response object, each key is the field name and value is the error message

Example:
{
  "email": "Invalid email address",
  "password": "Password is required"
}
​
support_id
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"