Get Dashboard Analytics

Get dashboard analytics data.

POST /api/v1/analytics/dashboard

Get Dashboard Analytics

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/analytics/dashboard \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "report_type": "last_7_days",
  "start_date": "<string>",
  "end_date": "<string>",
  "user_type": "<string>",
  "agent_name": "<string>",
  "organization": "<string>",
  "tab": "<string>"
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/analytics/dashboard"

payload = {
    "report_type": "last_7_days",
    "start_date": "<string>",
    "end_date": "<string>",
    "user_type": "<string>",
    "agent_name": "<string>",
    "organization": "<string>",
    "tab": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    report_type: 'last_7_days',
    start_date: '<string>',
    end_date: '<string>',
    user_type: '<string>',
    agent_name: '<string>',
    organization: '<string>',
    tab: '<string>'
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/analytics/dashboard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for requesting dashboard analytics.

report_type · string · default: last_7_days

start_date · string | null

end_date · string | null

user_type · string | null

agent_name · string | null

organization · string | null

tab · string | null

Response

200

OK