Static-audience upload status

Returns the current state of a single static-audience upload (custom-properties or segments file). You
receive the full URL for this endpoint as the status field on the response of the corresponding ingest-url
endpoint. You can also build the URL yourself with the type and file query parameters described below.

The status field of the response reports where the upload is in its lifecycle. When it is completed,
the ingestedAt field carries the timestamp of completion. To know whether a specific forecast already
includes this upload, compare ingestedAt against forecastEnvironment.staticAudiencesSyncDateTime on the
forecast response. When staticAudiencesSyncDateTime >= ingestedAt, the snapshot the forecast used was
sampled after the upload was persisted, so the upload is reflected.

Query Params
string
enum
required

The audience type the upload belongs to.

Allowed:
string
required

Composite identifier formatted as <uploadedAt>-<filename>, where <uploadedAt> is the epoch-millisecond
timestamp embedded in the upload's object key. Returned ready-to-use as part of the status URL on the
ingest-url response.

Responses

400

The type or file parameter is missing or malformed.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json