Data Extract

Get Guided Conversations Path Detail Report

Provides summary data for each executed path for a specified Guided Conversation within a given timeframe. Results are paginated.

get/v1/data_extract/guided_conversations_path_detail_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)

exchange_idinteger required

Exchange ID of the Guided Conversation. Only a single identifier can be passed.

Response

A custom data array of Guided Conversations Path Detail 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.