For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Signals by Business (Cursor)

This endpoint allows you to list signals for the authenticated business using cursor pagination and optional Elasticsearch filters. Business is taken from the API key..

GET {{baseurl}}/v2/api/signals/cursor

Headers

Name
Type
Description

token*

String

API secret token

Parameter

Field
Type
Description

limit

Number

Page size

Default value: 20

startAfter

String

Document id cursor for the next page (forward)

endingBefore

String

Document id cursor for the previous page (backward). Cannot be used with startAfter.

entityId

String

Filter to a single entity within the business

deviceId

String

Filter by device id

filterByAnomaly

Boolean

When true, apply the anomaly filter

anomaly

Boolean

Anomaly value when filterByAnomaly is true

deviceType

String

Comma-separated device types

os

String

Comma-separated OS names

startDate

String

Date-only YYYY-MM-DD (inclusive)

endDate

String

Date-only YYYY-MM-DD (inclusive)

{
   "success": true,
   "statusCode": 200,
   "message": "Signals retrieved successfully!",
   "data": {
       "docs": [],
       "nextCursor": "abc123",
       "prevCursor": null,
       "hasNextPage": true,
       "hasPrevPage": false,
       "totalDocs": 100
   },
   "links": []
}

Last updated

Was this helpful?