Interactions

get/v1/data/reports/interactions/{request_id}

Request

  • Base URL: https://{base_url}
  • URL: https://{base_url}/v1/data/reports/interactions/{request_id}
  • Auth: none declared

Path parameters

request_idstring required

Response

Report field Description:

<table> <tr> <th>Param Name</th> <th>Type</th> <th>Description</th> </tr> <tr> <td>page</td> <td>integer</td> <td>The current page number of the response from the total response present between the given date range</td> </tr> <tr> <td>size</td> <td>integer</td> <td>Number of interactions present in the current page</td> </tr> <tr> <td>total_pages</td> <td>integer</td> <td>Total number of pages present for the given date range.</td> </tr> <tr> <td>total_size</td> <td>integer</td> <td>Total number of interactions present for the given date range.</td> </tr> <tr> <td>interactions</td> <td>List</td> <td>This is the list of interactions (call, chat, external) included in the report. Each interaction in this list is associated with an interaction ID. Inside of each interactions following fields can be found.</td> </tr> <tr> <td>id</td> <td>String</td> <td>This id represents the id of that particular interaction</td> </tr> <tr> <td>account_id</td> <td>String</td> <td>This id represents the id of that particular account.</td> </tr> <tr> <td>agent_id</td> <td>String</td> <td>This id represents the id of the agent who has participated in that particular interaction.</td> </tr> <tr> <td>partner_agent_id</td> <td>String</td> <td>This id represents the id of the agent who has participated in that particular interaction in the client system.</td> </tr> <tr> <td>agent_name</td> <td>String</td> <td>The name of the agent who has participated in that particular interaction.</td> </tr> <tr> <td>agent_email</td> <td>String</td> <td>The email of the agent who has participated in that particular interaction.</td> </tr> <tr> <td>agent_status</td> <td>String</td> <td>This is a String field which depicts if the agent is active or not. (ACTIVE or IN_ACTIVE).</td> </tr> <tr> <td>interaction_url</td> <td>String</td> <td>This field represents the url for the particular interaction.</td> </tr> <tr> <td>duration</td> <td>integer</td> <td>This is an integer field which represents how much time (seconds) did the interaction happen.</td> </tr> <tr> <td>source_partner_meeting_id</td> <td>String</td> <td>Incase of split interactions, source_partner_meeting_id is the unique identifier for the interaction before split. source_partner_meeting_id is same as unique identifier in the client system.</td> </tr> <tr> <td>sequence</td> <td>Integer</td> <td>Incase of split interactions, the value of sequence signifies the position of this interaction post split. (Zero based index)</td> </tr> <tr> <td>language</td> <td>String</td> <td>This is a field which represents in which language did the communication happen during the interaction.</td> </tr> <tr> <td>channel</td> <td>String</td> <td>This field represents the type of interaction. (CALL, CHAT, EXTERNAL etc).</td> </tr> <tr> <td>provider_id</td> <td>String</td> <td>The id which originates from the source recording platform.</td> </tr> <tr> <td>transcripts</td> <td>List</td> <td>The list of transcripts of an interaction divided by speaker. The fields under the transcripts are:</td> </tr> <tr> <td>transcripts.phrase</td> <td>String</td> <td>A snippet from the transcript corresponding to one of the two speakers.</td> </tr> <tr> <td>transcripts.speaker</td> <td>String</td> <td>This is the speaker of the phrase - Agent or customer.</td> </tr> <tr> <td>transcripts.start_time</td> <td>integer</td> <td>The phrase start time in milliseconds.</td> </tr> <tr> <td>transcripts.end_time</td> <td>integer</td> <td>The phrase end time in milliseconds.</td> </tr> <tr> <td>transcripts.order</td> <td>integer</td> <td>The position of each phrase in a transcript.</td> </tr> <tr> <td>moment_categories</td> <td>List</td> <td>The list of moment categories contains all the moment categories found in the interactions. The fields under the moment categories are:</td> </tr> <tr> <td>moment_categories.moment_category_id</td> <td>String</td> <td>This id represents that particular moment_category.</td> </tr> <tr> <td>moment_categories.moment_category_name</td> <td>String</td> <td>The name of the particular moment_category.</td> </tr> <tr> <td>moment_categories.moments</td> <td>List</td> <td>The list of moments present under a particular moment category. The fields under the moment are:</td> </tr> <tr> <td>moments.moment_id</td> <td>String</td> <td>The id which represents that particular moment.</td> </tr> <tr> <td>moments.moment_name</td> <td>String</td> <td>The moment name as configured in the Observe.AI userinterface in the 'Moments' tab.</td> </tr> <tr> <td>moments.snippets</td> <td>List</td> <td>The list of phrases from a transcript in which momentswere found. Inside This snippets there are four more fields:</td> </tr> <tr> <td>moments.moment_theme</td> <td>String</td> <td>The moment theme - Positive/Negative/Neutral as configured in the Observe.AI userinterface in the ‘Moments’ tab.</td> </tr> <tr> <td>snippets.evidence</td> <td>String</td> <td>The actual phrase or keyword that matches amoment's criteria.</td> </tr> <tr> <td>snippets.start_time</td> <td>integer</td> <td>The phrase start time in milliseconds.</td> </tr> <tr> <td>snippets.end_time</td> <td>integer</td> <td>The phrase end time in milliseconds.</td> </tr> <tr> <td>snippets.order</td> <td>integer</td> <td>The position of each phrase in a transcript.</td> </tr> <tr> <td>moments.found</td> <td>boolean</td> <td>It determines whether the moment is found in the call or not.</td> </tr> <tr> <td>created_at</td> <td>Date</td> <td>The time at which the interaction was created in the DB.</td> </tr> <tr> <td>updated_at</td> <td>Date</td> <td>The time at which the interaction was last updated.</td> </tr> <tr> <td>interaction_start_time</td> <td>Date</td> <td>The start timestamp of the interaction in ISO time format.</td> </tr> <tr> <td>interaction_meta_data</td> <td>(Key, Value) pair</td> <td>This contains all the interaction metadata which is used to create filters and present in interaction info.</td> </tr> </table>

Changes

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