# Engagement Dashboards (Stream) API V3 — Developer Guide

**Applies to:** Sprinklr Engagement Dashboard Stream APIs V3

**V2 API reference:** [Engagement Dashboard](https://legacy-dev.sprinklr.com/engagement-dashboard)

## 1. Overview

Stream API allows the user to fetch the data flowing through a particular column configured in an Engagement dashboard or care console or agent console. This can be an outbound or inbound column. Once the column is created in Sprinklr, it has a unique stream ID assigned to it which can be used in the API call to extract data.

📖 Related Knowledge Base Article: [Engagement Dashboard](https://www.sprinklr.com/help/articles/getting-started-with-social-engagement/what-can-you-do-with-engagement-dashboards/6450dc2fd85662201933c821)

## 2. API Endpoints

`POST`https://api3.sprinklr.com/{env}/api/v3/streams/feed?streamId={streamId}
`GET`https://api3.sprinklr.com/{env}/api/v3/streams/feed?cursorId={nextPageCursor}

## 3. Base URLs and Environments

**All API calls are sent to the production endpoint:**

```http
https://api3.sprinklr.com/{env}/api/v3
```

So the resource in production is:

```http
https://api3.sprinklr.com/{env}/api/v3/streams/feed
```

Replace {env} with your assigned environment identifier (prod0, prod2, prod11, and so on — see [APIs | Sprinklr Developer Portal](https://legacy-dev.sprinklr.com/apis) for the environment list).

## 4. Authentication and Common Headers

API headers include the mandatory information you send along with the request URL and body. This information helps provide insights into request context and authorization credentials that, in turn, allows access to protected resources.

| Header | Value | Description |
|  --- | --- | --- |
| `Authorization` | `Bearer {token}` | Authenticates the user with the server. |
| `Key` | `{api-key}` | Authenticates the application with the server. |
| `Content-Type` | `application/json` | Identifies the request-body media type. |
| `Accept` | `application/json` | Identifies the expected response type. |


## 5. Read Operations

All payloads below are **illustrative**. Credentials are placeholders; identifiers are reproduced from the supplied operation documents.

### 5.1 Fetch Inbound Column Stream

Fetches stream data for inbound columns available in engagement dashboards with Sprinklr Modern Engagement.

**Endpoint**: api/v3/streams/feed?streamId={streamId}

> **Note.** If more data is available, the response carries a cursor as `nextPageCursor`, which you pass to the Stream Cursor API to fetch the next set of data.


#### Path Parameter

| Parameter | Required/Optional | Description | Type |
|  --- | --- | --- | --- |
| `streamId` | Required | Stream id of the inbound column to fetch data from. You can fetch the stream id using the Read Dashboard API. | String |


#### Query Parameters

Fields documented in the operation document:

| Parameter | Required/Optional | Description | Type |
|  --- | --- | --- | --- |
| `start` | Required | Starting index for retrieving records; used as the pagination offset. Example: `0`. | Integer |
| `rows` | Required | Number of records to be returned in the response. Example: `2`. | Integer |
| `sortField` | Required | Field name used to sort the results. Example: `CHANNEL_CREATED_TIME`. | String |
| `sortOrder` | Required | Sorting direction. `ASC` for ascending, `DESC` for descending. Example: `ASC`. | String |


#### Example Request

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/streams/feed?streamId={streamId}' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Key: {apiKey}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
-d '{
  "start": 0,
  "rows": 2,
  "sortField": "CHANNEL_CREATED_TIME",
  "sortOrder": "ASC"
}'
```

#### Example Response

```json
{ 
    "data": { 
        "entities": [ 
            { 
                "sourceType": "ACCOUNT", 
                "sourceId": 66073052, 
                "content": { 
                    "text": "@__sri_hari_77_ replying to a comment", 
                    "isRichText": false 
                }, 
                "channelMessageId": "18030998506826658", 
                "channelType": "INSTAGRAM", 
                "accountType": "INSTAGRAM", 
                "channelCreatedTime": 1704988068000, 
                "senderProfile": { 
                    "name": "Restricted data", 
                    "channelType": "INSTAGRAM", 
                    "channelId": "Restricted data", 
                    "permalink": "Restricted data", 
                    "avatarUrl": "Restricted data", 
                    "followers": 7, 
                    "following": 2, 
                    "username": "Restricted data", 
                    "unSubscribed": false, 
                    "deleted": false, 
                    "snCreatedTime": 0, 
                    "snModifiedTime": 0, 
                    "statusCount": 355, 
                    "accountSpecificInfos": [ 
                        { 
                            "accountId": 600000341 
                        }, 
                        { 
                            "accountId": 66073052 
                        } 
                    ] 
                }, 
                "receiverProfile": { 
                    "name": "Sri Hari", 
                    "channelType": "INSTAGRAM", 
                    "channelId": "__sri_hari_77_", 
                    "permalink": "https://scontent.cdninstagram.com/v/t51.2885-19/446098446_308849882315446_4007693697047206502_n.jpg?stp=dst-jpg_s206x206&_nc_cat=110&ccb=1-7&_nc_sid=bf7eb4&_nc_ohc=hvAtHTSTzxAQ7kNvgE8vMLz&_nc_zt=24&_nc_ht=scontent.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AYDcbmN8UNFmi8CaG1rUET7q0uiO3yVFKYrSOA7P1zuC5w&oe=67252B50", 
                    "avatarUrl": "https://instagram.com/__sri_hari_77_", 
                    "followers": 187, 
                    "following": 0, 
                    "username": "__sri_hari_77_", 
                    "verified": false, 
                    "unSubscribed": false, 
                    "deleted": false, 
                    "snCreatedTime": 0, 
                    "snModifiedTime": 0, 
                    "statusCount": 0, 
                    "accountSpecificInfos": [] 
                }, 
                "mentionedProfiles": [ 
                    { 
                        "channelType": "INSTAGRAM", 
                        "channelId": "__sri_hari_77_", 
                        "followers": 0, 
                        "following": 0, 
                        "username": "__sri_hari_77_", 
                        "deleted": false, 
                        "snCreatedTime": 0, 
                        "snModifiedTime": 0, 
                        "statusCount": 0, 
                        "accountSpecificInfos": [] 
                    } 
                ], 
                "permalink": "https://www.instagram.com/p/C19ypmoSOqz/c/18029851801830230/r/18030998506826658", 
                "language": "en", 
                "messageId": "ACCOUNT_66073052_1704988068000_INSTAGRAM_306_18030998506826658", 
                "postId": 130996273, 
                "brandPost": true, 
                "createdTime": 1781274222523, 
                "modifiedTime": 1781274223960, 
                "textEntities": { 
                    "message": [ 
                        { 
                            "indices": [ 
                                0, 
                                15 
                            ], 
                            "screenName": "__sri_hari_77_" 
                        } 
                    ] 
                }, 
                "insights": {}, 
                "workflow": { 
                    "campaignId": "66000002_2" 
                }, 
                "enrichments": {}, 
                "conversationId": "3277998865097747123_62647274115", 
                "parentMessageId": "ACCOUNT_66073052_1704987978000_INSTAGRAM_37_18029851801830230", 
                "autoImported": true, 
                "autoResponse": false 
            }, 
            { 
                "sourceType": "ACCOUNT", 
                "sourceId": 66073052, 
                "content": { 
                    "text": "@__sri_hari_77_ testing reply on a reply", 
                    "isRichText": false 
                }, 
                "channelMessageId": "18069592015461480", 
                "channelType": "INSTAGRAM", 
                "accountType": "INSTAGRAM", 
                "channelCreatedTime": 1704988099000, 
                "senderProfile": { 
                    "name": "Restricted data", 
                    "channelType": "INSTAGRAM", 
                    "channelId": "Restricted data", 
                    "permalink": "Restricted data", 
                    "avatarUrl": "Restricted data", 
                    "followers": 7, 
                    "following": 2, 
                    "username": "Restricted data", 
                    "unSubscribed": false, 
                    "deleted": false, 
                    "snCreatedTime": 0, 
                    "snModifiedTime": 0, 
                    "statusCount": 355, 
                    "accountSpecificInfos": [ 
                        { 
                            "accountId": 600000341 
                        }, 
                        { 
                            "accountId": 66073052 
                        } 
                    ] 
                }, 
                "receiverProfile": { 
                    "name": "Sri Hari", 
                    "channelType": "INSTAGRAM", 
                    "channelId": "__sri_hari_77_", 
                    "permalink": "https://scontent.cdninstagram.com/v/t51.2885-19/446098446_308849882315446_4007693697047206502_n.jpg?stp=dst-jpg_s206x206&_nc_cat=110&ccb=1-7&_nc_sid=bf7eb4&_nc_ohc=hvAtHTSTzxAQ7kNvgE8vMLz&_nc_zt=24&_nc_ht=scontent.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AYDcbmN8UNFmi8CaG1rUET7q0uiO3yVFKYrSOA7P1zuC5w&oe=67252B50", 
                    "avatarUrl": "https://instagram.com/__sri_hari_77_", 
                    "followers": 187, 
                    "following": 0, 
                    "username": "__sri_hari_77_", 
                    "verified": false, 
                    "unSubscribed": false, 
                    "deleted": false, 
                    "snCreatedTime": 0, 
                    "snModifiedTime": 0, 
                    "statusCount": 0, 
                    "accountSpecificInfos": [] 
                }, 
                "mentionedProfiles": [ 
                    { 
                        "channelType": "INSTAGRAM", 
                        "channelId": "__sri_hari_77_", 
                        "followers": 0, 
                        "following": 0, 
                        "username": "__sri_hari_77_", 
                        "deleted": false, 
                        "snCreatedTime": 0, 
                        "snModifiedTime": 0, 
                        "statusCount": 0, 
                        "accountSpecificInfos": [] 
                    } 
                ], 
                "permalink": "https://www.instagram.com/p/C19ypmoSOqz/c/18029851801830230/r/18069592015461480", 
                "language": "en", 
                "messageId": "ACCOUNT_66073052_1704988099000_INSTAGRAM_306_18069592015461480", 
                "postId": 130996275, 
                "brandPost": true, 
                "createdTime": 1781274222524, 
                "modifiedTime": 1781274223941, 
                "textEntities": { 
                    "message": [ 
                        { 
                            "indices": [ 
                                0, 
                                15 
                            ], 
                            "screenName": "__sri_hari_77_" 
                        } 
                    ] 
                }, 
                "insights": {}, 
                "workflow": { 
                    "campaignId": "66000002_2" 
                }, 
                "enrichments": {}, 
                "conversationId": "3277998865097747123_62647274115", 
                "parentMessageId": "ACCOUNT_66073052_1704987978000_INSTAGRAM_37_18029851801830230", 
                "autoImported": true, 
                "autoResponse": false 
            } 
        ], 
        "hasMore": true, 
        "nextPageCursor": "6a86cade6904d47b4502c9ee" 
    }, 
    "errors": [] 
}
```

#### Response Parameter

| Parameter | Description | Type |
|  --- | --- | --- |
| `nextPageCursor` | The `nextPageCursor` you get in the response will be used in the Stream Cursor API to fetch the next set of data. | String |


### 5.2 Stream Cursor API

Fetches the next set of available data.

**Endpoint**: api/v3/stream/cursor/{nextPageCursor}

> **Note.** The above {nextPageCursor} is the one you receive in the response from either the Outbound or Inbound API. So before using this API call, you should use the Outbound/Inbound API to receive the nextPageCursor in the response.


#### Path Parameter

| Parameter | Required/Optional | Description | Type |
|  --- | --- | --- | --- |
| `nextPageCursor` | Required | The cursor you received in the response of the Outbound/Inbound API call. Example: `"nextPageCursor": "6a86cade6904d47b4502c9ee"` | String |


#### Example Request

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/streams/feed?cursorId={nextPageCursor}' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json'
```

#### Example Response

```json
{
  "data": {
    "entities": [
      {
        "sourceType": "ACCOUNT",
        "sourceId": 66073052,
        "content": {
          "text": "@__sri_hari_77_ replying to the comment",
          "isRichText": false
        },
        "channelMessageId": "17896145114952536",
        "channelType": "INSTAGRAM",
        "accountType": "INSTAGRAM",
        "channelCreatedTime": 1705996114000,
        "permalink": "https://www.instagram.com/p/C2b1gW1AUt0/c/18115322911346405/r/17896145114952536",
        "language": "en",
        "messageId": "ACCOUNT_66073052_1705996114000_INSTAGRAM_306_17896145114952536",
        "postId": 130996277,
        "brandPost": true,
        "createdTime": 1781274226146,
        "modifiedTime": 1781274229063,
        "insights": {},
        "workflow": { "campaignId": "66000002_2" },
        "enrichments": {},
        "conversationId": "3286455673096850292_62647274115",
        "parentMessageId": "ACCOUNT_66073052_1705996091000_INSTAGRAM_37_18115322911346405",
        "autoImported": true,
        "autoResponse": false
      }
    ],
    "hasMore": false
  },
  "errors": []
}
```

> **Note.** You will receive another cursor if more data is available to fetch. You can use the id given in nextPageCursor to make another GET call.


## 6. Use Cases

##### 1. Fetch data from an Engagement Dashboard column

Retrieve the data flowing through a particular column configured in an Engagement Dashboard by providing its unique streamId.

##### 2. Retrieve inbound stream data

Fetch data from an inbound column configured in Sprinklr Modern Engagement. The documented response can include message content, channel information, profiles, message identifiers, timestamps, conversation information, and workflow data.

##### 3. Retrieve data from Care Console or Agent Console columns

Use a column's unique stream ID to extract data flowing through columns configured in a Care Console or Agent Console, in addition to Engagement Dashboards.