Dataset

Datasets

Dataset defines the entities that Comm100 can query for reporting. All of them can be obtained through the api.

• Datasets
  • GET /reporting/datasets - Get the list of datasets

Dataset JSON Format

Dataset is represented as simple flat JSON objects with the following keys:

Metric JSON Format

Metric is represented as simple flat JSON objects with the following keys:

Attribute JSON Format

Attribute is represented as simple flat JSON objects with the following keys:

Get Datasets

GET /reporting/datasets

• Request parameters

  No parameters.
  
  

• Response body:

  An array of Dataset.
  
  

• Example

  • Request

  curl https://api11.comm100.io/reporting/datasets?siteid=10000 \
  -X 'GET' \
  -H 'Authorization: Bearer {access_token}'
  

  • Response
    HTTP/1.1 200 OK

  [
    {
        "id": "Chat",
        "name": "Chat",
        "description": "Create customized reports on chat volumes and agent performance. Examples include chats, chat requests, missed chats, chat rating, wait time, chat messages, etc.",
        "module": "Live Chat",
        "metrics": [
            {
                "id": "AbandonedChats",
                "name": "Abandoned Chats",
                "availableAggregators": [
                    "count"
                ],
                "description": "The number of chat requests abandoned by visitors before connecting with agents.",
                "type": "number"
            },
            ...
        ],
        "attributes": [
            {
                "id": "ChatAgent",
                "name": "Agent",
                "type": "string"
            },
            ...
        ],
    },
    ...
  ]