List available reporting datasets and attributes | Intercom API (unofficial showcase)

1 parameter

Intercom-Versionstringoptional

The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.

Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

1 status code

200Returns an object containing the available datasets, including each dataset's identifier, name, description, default time attribute, and attributes.

typestringoptional

dataarray<object>optional

Error handling

The Intercom-Version header selects the API version and defaults to 2.17 when omitted. Use a supported API version if you provide the header.

import { Client } from "@octridev/intercom";

const client = new Client({
  baseUrl: "https://api.intercom.io",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.getDatasets.list();

{
  "type": "list",
  "data": [
    {
      "id": "conversation",
      "name": "Conversation",
      "description": "Conversation-level details: status, channel, assignee.",
      "default_time_attribute_id": "conversation_started_at",
      "attributes": [
        {
          "id": "conversation_id",
          "qualified_id": "conversation.conversation_id",
          "name": "Conversation ID"
        }
      ]
    }
  ]
}

Request

Response

Errors