BEbeyondwords
Agent

Content

Changed on

Retrieves per-content usage aggregates for the AI assistant

get/projects/{project_id}/agent/analytics/content

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/agent/analytics/content
  • Auth
    API key in header X-Api-Key

Query parameters

agent_type'conversational_agent' | 'ai_assistant' required
time_range[start]string

The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601.

time_range[end]string

The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still in progress and therefore only partial analytics data is returned until the day ends.

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

order[by]'title' | 'published_at' | 'total_uses' | 'fetches' | 'read_requests' | 'audio_requests' | 'last_used_at'

Order content results

order[dir]'asc' | 'desc'

This is used to order analytics in the ascending or descending order

access_tiers[]string[]

The access tiers to fetch data for

filter[query]string

Response

OK

idstring uuid

Content identifier (Podcast uuid)

titlestring nullable

Content title

source_urlstring nullable

Canonical source URL for this content item

published_atstring date-time nullable

Content publication timestamp (ISO 8601, UTC)

fetchesinteger

Number of get_article calls

read_requestsinteger

Number of read_article calls (repeated pagination calls each count separately)

audio_requestsinteger

Number of get_audio calls

segments_returnedinteger

Sum of segments_returned across calls

total_usesinteger

Total number of tool calls referencing this content

last_used_atstring date-time nullable

Time of the most recent tool call referencing this content (ISO 8601, UTC)

Changes