Data Extract

Get Guided Conversations Most Traveled Report

Get the Top 20 Most Traveled Paths for each Guided Conversation based on supplied parameters. Results are paginated.

get/v1/data_extract/guided_conversations_most_traveled_report

Request

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

Query parameters

pageinteger

Result page number

limitinteger

Number of results per page

created_at_utc_startstring required

Start datetime of when guided conversations were executed in UTC (Format: YYYY-MM-DD HH:MM:SS)

created_at_utc_endstring required

End datetime of when guided conversations were executed in UTC (Format: YYYY-MM-DD HH:MM:SS)

folder_idinteger

Folder ID for filtering guided conversations. Can be repeated for multiple folders (e.g., ?folder_id=1&folder_id=2)

concierge_idinteger

Concierge ID for filtering guided conversations. Can be repeated for multiple concierges (e.g., ?concierge_id=1&concierge_id=2)

Response

A custom data array of Guided Conversations Most Traveled Report objects

bodyobject

Json body data in the request

limitinteger

Number of results returned

pageinteger

Page of results returned

parametersobject

Query parameters in the request

Changes

No recorded changes to this operation across all 1 revision of this API.