GET /external/v1/signalsList a bounded page of signals in your workspace. Signals are imported pieces of customer or market evidence such as transcripts, support tickets, reviews, and discovery reports.
Requirements
API scopes required:
signals:read
Request
Parameters
| Name | Type | Description |
|---|---|---|
| limit | number | Maximum number of items to return (default: 20, maximum: 100) |
| offset | number | Number of items to skip (default: 0) |
| externalId | string | Exact identifier of the record in its source system, such as a Fireflies transcript ID. |
| integrationId | uuid | Only signals imported through this workspace integration. |
| sourceType | string | Comma-separated source filters. Each value matches a provider type such as fireflies, a source facet such as fireflies:transcript, or a source type. |
| initiativeId | string | Only signals with an accepted evidence link to this Initiative. Accepts the Initiative UUID or public ID, such as INITIATIVE-7. |
| studyId | string | Only signals attached to this Study as interviews. Accepts the Study UUID or public ID, such as STUDY-172. |
| status | string | Comma-separated processing statuses: pending, processing, processed, or failed. |
| accountId | uuid | Signals linked to this account directly, or through an insight linked to it. Only direct links appear in accountIds. Comma-separate several IDs to match any of them. |
| updatedSince | iso-date | Only signals whose own fields changed at or after this ISO-8601 timestamp, oldest change first. Pass the latest updatedAt you have received to sync incrementally, and dedupe by id. Links added later to insights, Initiatives, or Studies do not count as changes. |
| include | string | Comma-separated extras. 'raw' adds rawData: the whole stored data column, including every attributed transcript turn and the provider's import response. Opt-in because it can exceed several hundred KB per signal. |
Responses
200
SuccessSignals were successfully retrieved. Pagination metadata is returned in X-Total-Count, X-Limit, X-Offset, and X-Has-More headers.
Schema
Array<Signal>
Example Request
GET
/external/v1/signalscurl
curl -X GET https://zentrik.ai/api/external/v1/signals?limit=10 \
-H 'Authorization: Bearer YOUR_API_KEY'Example Response
200 OK
json
[
{
"id": "uuid",
"name": "Support Ticket - 3/20/24, 10:00 AM",
"publicId": "SIGNAL-42",
"workspaceId": "workspace-uuid",
"status": "processed",
"context": "support_request",
"signalType": null,
"processorType": "zendesk",
"providerType": "zendesk",
"evidenceKind": "support_ticket",
"analysisProfile": "support_ticket",
"provenance": {
"providerType": "zendesk",
"evidenceKind": "support_ticket",
"analysisProfile": "support_ticket"
},
"sourceFacet": "zendesk:support_ticket",
"sourceLabel": "Zendesk support ticket",
"sourceLinks": [
{
"name": "Open Zendesk ticket",
"url": "https://example.zendesk.com/agent/tickets/12345",
"type": "support_ticket",
"primary": true
}
],
"source": {
"type": "zendesk",
"external_data": {
"ticketId": "12345"
}
},
"data": {
"subject": "Users cannot reset password",
"severity": "high"
},
"transcript": null,
"import": null,
"insightIds": [],
"accountIds": [],
"initiativeIds": [],
"studyIds": [],
"accountId": null,
"accountExternalId": null,
"externalId": "external-123",
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z"
}
]