Get most used sources

GET

/api/v1/visitors/common_sources

The knowledge sources the AI cited most often in its answers. This is the most used sources list on the dashboard’s performance page.

Notes

• Returns at most 10 sources, sorted by count, highest first
• startTime and endTime are Unix timestamps in milliseconds, not YYYY-MM-DD days. Leave them out to cover the whole history
• stableId identifies the source in the content library. A source that has been removed since keeps its count, with <Source is removed> as its title
• Computed live rather than read from a query cache, so there is no status or forceRefresh

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

startTime

integer format: int64

Start of the range as a Unix timestamp in milliseconds. Defaults to the beginning of the history.

endTime

integer format: int64

End of the range as a Unix timestamp in milliseconds. Defaults to now.

personalizationId

string

Restrict the list to one channel. Leave it out to cover every channel. all-ai-assistants covers every AI assistant on your website and excludes API traffic. API channels include api, api-summarization, api-team-assistant, api-team-assistant-summarization, api-dashboard, api-report, api-ticket-analysis and api-resource-optimization.

segmentId

string

Restrict the list to one segment. Leave it out for the list across all segments.

Responses

200

The most cited sources.

object

results

Array<object>

object

stableId

Identifies the source in the content library.

string

title

Title of the source, or <Source is removed> when it no longer exists.

string

count

How many answers in the range cited the source.

integer

Example

{
  "results": [
    {
      "stableId": "3c1f9a7e2b",
      "title": "Resetting your password",
      "count": 318
    },
    {
      "stableId": "8d4e2b6a1f",
      "title": "Payment methods",
      "count": 204
    }
  ]
}

400

The workspace could not be determined from the headers.

401

Unauthorized - invalid API key.