Sync signals
Required capabilities:
subscribeSignalsAcl:READ
Retrieve signals for a sink incrementally. Unlike the list endpoint, the returned cursor is persistent and can be stored and reused later to fetch only signals that arrived after the previous sync. The response always includes a nextCursor, and moreData indicates whether more signals are immediately available.
Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Headers
cdf version header. Use this to specify the requested CDF release.
"alpha"
Body
Sync request for signals.
Request for syncing signals for a sink.
Reference to a sink. If the type is "user", the user must exist in the user profiles API.
Cursor returned by a previous sync request. Omit to start syncing from the beginning. Unlike list cursors, sync cursors are persistent and may be stored and reused later.
Maximum number of signals to return.
1 <= x <= 1000Response
A list of signals, a cursor for the next sync, and a flag indicating whether more data is available.
List of signals with a persistent cursor for the next sync.
1000Cursor to use in the next sync request. Always present.
Whether more signals are immediately available. If true, another sync request with the returned cursor will return more results right away.