POST
/
v1
/
general
/
dashboard-stats
curl --request POST \
  --url https://api.pulze.ai/v1/general/dashboard-stats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": [],
  "date_from": "2023-11-07T05:31:56Z",
  "date_to": "2023-11-07T05:31:56Z",
  "app_ids": [],
  "cumulative": {},
  "type": "dashboard",
  "graphs": [
    "latency"
  ]
}'
[
  {
    "large": true,
    "cumulative": true,
    "name": "<string>",
    "label": "<string>",
    "id": "latency",
    "color": "<string>",
    "data": [
      {
        "date": "<string>",
        "x": "<string>",
        "y": 123,
        "y_units": "<string>"
      }
    ],
    "max": 123,
    "total": 123,
    "interval": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
date_from
string
required

The earliest date we are searching for.

​
cumulative
object | null
required
​
type
enum<string>
required
Available options:
dashboard,
usage,
custom
​
params
object[]

The sorting parameters for the query

​
date_to
string | null

The latest date we are searching for.

​
app_ids
string[]

The list of API Keys we want to filter for. Leave the list empty to disable filtering (and return data for all apps) instead.

​
graphs
enum<string>[] | null
Available options:
latency,
errors,
requests,
savings,
costs

Response

200
application/json
Successful Response
​
name
string
required
​
label
string
required
​
id
enum<string>
required
Available options:
latency,
errors,
requests,
savings,
costs
​
color
string
required
​
data
object[]
required
​
max
number
required
​
total
number
required
​
interval
string
required
​
large
boolean | null
default:false
​
cumulative
boolean | null

Was this page helpful?

Raise issue