Skip to content

Get an environment's analytics dashboard

GET /analytics/dashboard

Query Parameters

environment_idstring · uuid

The environment to report on; the caller must be able to reach it. Required with a session. With an API token it defaults to the token's environment.

rangestring

A named range ending today, inside the 90-day window. mtd is this month, last_month the whole of last month, 7d / 30d / 90d the last 7, 30 or 90 days. Send this or from / to, not both. Defaults to mtd.

Possible values:
mtdlast_month7d30d90d
fromstring · date

A custom range's first UTC day (inclusive). Defaults to 30 days before to. Clamped to the 90-day window.

tostring · date

A custom range's last UTC day (inclusive). Defaults to today; a range that includes today runs up to now.

filterobject

Page filters, filter[category]=<id> and filter[integration]=<name>. Each part takes the ones its metric accepts; the headline numbers take none.

Example: {"integration":"hubspot"}
categorystring

A category id from GET /analytics/metrics, e.g. unified_api.

integrationstring

An integration name, as the logs record it (e.g. hubspot).

accounts_cursorstring

The accounts.next_cursor of the previous response, for the next page of accounts. The rest of the response is the same (served from the cache).

accounts_searchstring

Only accounts whose id starts with this.

Response Body

account_eventsobject[]

Integrated account lifecycle events in the range, from the logs (for example created, updated, deleted).

countinteger
eventstring
accountsobject

One page of the integrated accounts with the most API calls in the range. Only accounts that still exist are listed.

next_cursorstring

Pass as accounts_cursor for the next page.

rowsobject[]
10 properties
callsinteger
errorsinteger
integrationstring
keystring

The integrated account id.

labelstring

The account's context.label, when it is text.

last_active_atstring · date-time
last_active_daystring · date
statusstring
tenant_idstring
valuenumber

API calls.

searchstring
api_callsobject

API calls per day (as billing counts them), aligned with buckets. null when it could not be loaded.

bucketsstring[]
by_categoryobject[]
3 properties
keystring
totalnumber
valuesnumber[]
by_integrationobject[]
3 properties
keystring
totalnumber
valuesnumber[]
totalobject[]
3 properties
keystring
totalnumber
valuesnumber[]
bucketsstring[]
by_categoryobject[]
callsinteger
categorystring
cache_secondsinteger

How long the parts of this response are cached.

Example: 21600
environment_idstring · uuid
errors_by_integrationobject[]

The integrations with the most requests that returned HTTP 400 or above. An empty key is calls with no integration (Admin API calls, and requests that failed before an integration was known).

keystring
valuenumber
filtersRecord<string, any>

The page filters applied, as sent.

fromstring · date
generated_atstring · date-time

When the numbers were read. Responses are cached for 6 hours, so a range that includes today shows today as of this time.

hourly_api_callsobject

API calls per hour (UTC) over the last 7 days of the range; an hour later today is null.

bucketsstring[]
fromstring · date
tostring · date
valuesnumber[]
integrationsobject[]

Every integration with API calls in the range or integrated accounts now, by API calls.

accountsinteger
active_accountsinteger
attention_accountsinteger

Accounts with status needs_reauth, validation_error or post_install_error now.

callsinteger

API calls as billing counts them (the billable_api_calls filter).

errorsinteger
integrationstring
requestsinteger

API requests, the denominator of the error rate.

inventoryobject

The environment's integrations and integrated accounts as they are now (sandbox accounts excluded).

accountsinteger
active_connectionsinteger
active_connectorsinteger
as_ofstring · date-time
by_statusRecord<string, any>
installed_connectorsinteger
superquery_accountsinteger
kpisobject

Each headline number for the range, the span of the same length before it, and a daily series. accounts, active_accounts and active_integrations describe the accounts as they are now, so they have no previous value or series.

accountsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

active_accountsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

active_integrationsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

api_callsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

billable_api_callsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

error_rateobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

errorsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

latency_p95object
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

mcp_callsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

new_accountsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

provider_latency_p95object
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

rate_limitedobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

records_syncedobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

sync_failuresobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

webhook_eventsobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

webhook_failure_rateobject
3 properties
previousnumber

The same figure for the span of equal length just before the range (ending at the same time of day); null when that span is not inside the 90-day window, and for numbers that describe the accounts as they are now.

seriesnumber[]

One value per day of the range (null for a rate or latency with no requests that day); empty for numbers that describe the accounts as they are now.

valuenumber

Null when there is nothing to measure, e.g. a rate with no requests behind it.

latency_p95object

p95 latency per day in ms, total and waiting on the provider; null on a day without requests.

bucketsstring[]
providernumber[]
totalnumber[]
previousobject
fromstring · date
tostring · date
rangestring

The named range shown, or custom for from / to.

Possible values:
mtdlast_month7d30d90dcustom
status_codesobject[]

API requests by HTTP status class (2, 4, 5, ...), largest first.

keystring
valuenumber
tostring · date
unavailablestring[]

Parts that could not be loaded right now and are null (api_calls, latency, hourly_api_calls, status_codes, errors_by_integration, accounts).

windowobject

The days analytics can show (the last 90 days, up to today).

fromstring · date
tostring · date
curl -X GET 'https://api.truto.one/analytics/dashboard' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const response = await fetch('https://api.truto.one/analytics/dashboard', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/analytics/dashboard"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}

response = requests.get(url, headers=headers, params=params)
print(response.json())