Skip to main content
GET
/ai/activity/overview

Authorizations

Authorization
string
header
required

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

Query Parameters

range
enum<string>
default:thirty_days

Date range to report on. Preset ranges end yesterday and today is today so far. month_to_date is the current month so far and week_to_date is the current week so far. custom requires start and end (YYYY-MM-DD). Other values return a 400 error

Available options:
custom,
all_time,
today,
seven_days,
fourteen_days,
thirty_days,
three_months,
six_months,
week_to_date,
month_to_date,
quarter_to_date,
year_to_date,
last_week,
last_month,
last_quarter,
last_year,
month_on_month,
quarter_on_quarter,
yesterday
start
string<date>

Start date when range=custom

end
string<date>

End date when range=custom

date_group
enum<string>
default:day

Groups the daily series by day, month or quarter

Available options:
day,
month,
quarter
source
enum<string>

Only include one route: chat (Spark questions and chat naming) or summary (AI summaries)

Available options:
chat,
summary
organisation_id
string

Comma-separated organisation IDs

user_id
string

Comma-separated user IDs

outcome
enum<string>

Only include successful or failed requests

Available options:
success,
failure
user_type
enum<string>

Only include admins (admin) or everyone else (non_admin)

Available options:
admin,
non_admin
exclude_internal
enum<string>
default:0

Set to 1 to leave out internal organisations

Available options:
0,
1

Response

sources
object
required

The same figures per route, with tokens and cost split by token type; routes with no activity are left out

totals
object
required

Figures across every route included

daily
object[]
required

One row per day (or month or quarter, by date_group), with empty buckets as zeros

failures
object[]
required

Failures grouped into categories, largest first

pages
object[]
required

The ten pages with the most Spark questions

pages_other
object | null
required

Pages outside the top ten rolled up, or null when there are none

organisations
object[]
required

Up to 100 organisations, by cost

users
object[]
required

Up to 100 users, by cost

success
boolean
required