Dataset
  • 20 Dec 2022
  • 1 Minute to read
  • Dark
    Light

Dataset

  • Dark
    Light

Article Summary

Datasets

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

Dataset JSON Format

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

NameTypeDescription
idstringThe id of the dataset used to identify the dataset.
modulestringWhich product this dataset belongs to. Available values are: Live Chat, Ticketing & Messaging, Bot, Global Settings.
metricsMetric[]Predefined metrics in the dataset. You can use these metrics when using reporting query.
attributesAttribute[]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:

NameTypeDescription
idstringThe id of the metric used to identify the metric.
namestringThe name of the metric, which is usually used to display the metric.
descriptionstringExpress the specific meaning of this metric.
availableAggregatorsstring[]Which operators are applicable to this metric. Available items are: count, avg, max, min, sum, percentage.
typestringIn 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:

NameTypeDescription
idstringThe Id of the attribute used to identify the attribute.
namestringThe Name of the attribute.
typestringThe 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"
              },
              ...
          ],
      },
      ...
    ]
    

Was this article helpful?