Audience

Returns the audience inactivity sync with the given id.

Changed on
get/audience/inactivity-sync/{syncId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/audience/inactivity-sync/{syncId}
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

syncIdstring required

The unique identifier of the inactivity sync.

Response

OK

idstring required

The unique identifier of the inactivity sync.

audienceIdstring required

The audience this inactivity sync belongs to.

state'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Aborted' required
phase'MarkingInactiveUsers' | 'Finalizing' | 'Done' required
cutoffstring date-time required

The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.

lastProcessedUserIdstring nullable

The id of the last user that was processed (progress cursor).

processedCountinteger required

The number of users processed so far.

changedCountinteger required

The number of users whose state was changed by the sync.

errorMessagestring nullable

Error message populated when the sync transitioned to Failed.

startedAtstring date-time nullable

When the sync began processing (null while still Pending).

lastHeartbeatAtstring date-time nullable

Timestamp of the last heartbeat received from the worker.

completedAtstring date-time nullable

When the sync reached a terminal state (Completed, Failed, Aborted).

createdAtstring date-time required

When the sync was created.

Changes