KEkevel
Static Audiences

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.

get/forecaster/udb/ingest-status

Request

  • Base URL
    https://api.kevel.co/v1
  • URL
    https://api.kevel.co/v1/forecaster/udb/ingest-status
  • Auth
    API key in header X-Adzerk-ApiKey

Query parameters

type'custom-properties' | 'segments' required

The audience type the upload belongs to.

filestring 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.

Response

The current state of the upload.

status'incoming' | 'processing' | 'completed' | 'failed' | 'not-found'

The current state of the upload:

  • incoming: the file was received but has not yet been picked up.
  • processing: the file is being parsed.
  • completed: the file was correctly processed, and the ingestedAt field carries the timestamp of completion.
  • failed: an error was encountered while processing the file.
  • not-found: no upload matching the request is currently tracked.
ingestedAtstring nullable

UTC date-time at which the file was processed. Only present when status is completed.

Changes

No recorded changes to this operation across all 1 revision of this API.