Skip to content

Fetch monitoring dashboards

Request

Security
bearerAuth and apiKeyAuth
Query
namestring

Dashboard name to search for

additionalChannelsstring

Comma-separated channel types to include in dashboard columns

pageNumberstring

Page number (0-based), required

pageSizestring

Page size (default 20, max 100)

curl -i -X GET \
  'https://api3.sprinklr.com/prod/api/v3/monitoringDashboards?name=string&additionalChannels=string&pageNumber=string&pageSize=string' \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Array [
idstring

Dashboard id

namestring

Name of dashboard

shareConfigsArray of objects(AssetShareConfig)

Share configs of dashboard

columnOrderArray of strings

Column's ordering of dashboard

columnsArray of objects(Stream)

Columns in dashboard

tagsArray of strings

Tags of dashboard

lockedboolean

locked status of dashboard

standardboolean

Standard flag of dashboard

favoriteboolean

Favorite flag of dashboard

sharedboolean

Shared flag of dashboard

]
Response
[ { "id": "string", "name": "string", "shareConfigs": [ … ], "columnOrder": [ … ], "columns": [ … ], "tags": [ … ], "locked": true, "standard": true, "favorite": true, "shared": true } ]