The API retrieves metrics at the conversation level.

Authorization

  • Bearer token
  • OAuth 2.0 token

Request

Method URL
POST https://{domain}/ootb_reporting/api/account/{accountId}/conversations?conversationStartTime=2024-06-09T00:00:00.000Z~2024-06-15T23:59:59.999Z&timezone=Asia%2FKolkata&limit=10&apiSource=test

URL Parameters

Name Description Type Required Notes
conversationStartTime Requested time frame String Required Format example: 2024-06-09T00:00:00.000Z~2024-06-15T23:59:59.999Z
timezone Requested time zone String Optional Format example: Asia%2FKolkata
Default value: UTC
offset The offset specifies from which record to retrieve the data. Numeric Optional Default value: 0
limit Number of conversations in page Numeric Optional Default value: 50
sort Sort the results based on a given dimension String Optional The sort can only be done by one of the dimensions.
The dimensions should not be of array type.
sortorder Direction of the order in which the items will be displayed String Optional Valid values: asc / desc.
Default value: if sort provided and sortorder not provided, the sortorder will be “desc”.
apiSource Source name String Required  

Body Parameters :

Name Description Type Required Notes
filters Contains parameters to filter by (dimensions only). time frame Container Optional  
metricsToRetrieve List of metrics that are calculated for the given time range Array Required Valid values: Report Center Metrics and Dimensions

Request body example :

{
  "filters":{
    "conversationInfo_latestSkillName": ["bot skill","PCS" ]
  },
  "metricsToRetrieve": [
    "conversationInfo_latestSkillName","count_transfers","totalIft"
  ]
}

Response example :

{
  "totalRows": 5,
  "rows": [
    {
      "convId": "e5a74f3e-27dc-4cb7-9c54-cd068fb4bef4",
      "count_transfers": 3.0,
      "conversationInfo_latestSkillName": "bot skill"
    },
    {
      "convId": "44644d3f-9f8f-458f-a604-ad1a531fe142",
      "count_transfers": 0.0,
      "conversationInfo_latestSkillName": "PCS"
    },
    {
      "convId": "fbbf7fb1-b8ed-42e6-931a-e1f3a6cff808",
      "count_transfers": 0.0,
      "conversationInfo_latestSkillName": "PCS"
    },
    {
      "convId": "3794b6a0-0364-490a-af03-6daa8490a412",
      "count_transfers": 0.0,
      "totalIft": 0.20,
      "conversationInfo_latestSkillName": "PCS"
    },
    {
      "convId": "52cad09f-58e5-44a3-903b-4f1900c9b2e9",
      "count_transfers": 0.0,
      "totalIft": 0.18,
      "conversationInfo_latestSkillName": "PCS"
    }
  ]
}

Limitations

  • The APIs support only metrics and dimensions that are associated with the conversation model
  • Filters:
    • Users can filter data based on all dimensions (not including time dimensions).
    • Up to 1000 values for all filter.