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:

Name	Type	Description
`id`	string	The id of the dataset used to identify the dataset.
`module`	string	Which product this dataset belongs to. Available values are: `Live Chat`, `Ticketing & Messaging`, `Bot`, `Global Settings`.
`metrics`	Metric[]	Predefined metrics in the dataset. You can use these metrics when using reporting query.
`attributes`	Attribute[]	Predefined attributes in the dataset. You can use attribute to filter or group reports.

Metric JSON Format

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

Name	Type	Description
`id`	string	The id of the metric used to identify the metric.
`name`	string	The name of the metric, which is usually used to display the metric.
`description`	string	Express the specific meaning of this metric.
`availableAggregators`	string[]	Which operators are applicable to this metric. Available items are: `count`, `avg`, `max`, `min`, `sum`, `percentage`.
`type`	string	In which type to present the calculation result of the metric. Available items are: "timespan", "number", "percentage".

Attribute JSON Format

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

Name	Type	Description
`id`	string	The Id of the attribute used to identify the attribute.
`name`	string	The Name of the attribute.
`type`	string	The type of the attribute. Available values are: `string`, `datetime`, `enum`.

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"
          },
          ...
      ],
  },
  ...
]