Agent Bookings

Booking breakdown for an agent, by region → job type group.

Sources dbt.fct_upsmith_bookings scoped by its direct agent attribution via the shared _BOOKING_ROW_TYPE_FILTER so "Booked" can't disagree across surfaces. Filters (region / job type group / business unit / status) and the range preset narrow the set; available_filters lists every value present for the agent regardless of the current filter so the dropdowns stay populated. Passing no status counts every non-canceled booking that reached a ServiceTitan job — the same default the homepage card applies, so the two surfaces agree. format=csv streams the matching bookings as a per-job CSV for portal reconciliation.

month (YYYY-MM) overrides range for the day view: the headline total and CSV cover that calendar month, while by_day covers the Sunday-aligned calendar grid the month renders in (so boundary-week totals can include adjacent-month days).

get/campaigns/agents/{agent_module_id}/bookings

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

agent_module_idstring required

Query parameters

rangestring

group_bystring

monthstring nullable

regionstring[] nullable

job_type_groupstring[] nullable

business_unitstring[] nullable

statusstring[] nullable

formatstring

Headers

organization-idstring nullable

x-user-idstring nullable

timezonestring

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.