KEkevel
Static Audiences

Static user custom properties ingest URL

This endpoint allows you to push static audiences, represented by user custom properties, directly to Kevel Forecast. When you create a new ingest URL, we'll give you back a signed URL for an Amazon S3 bucket.

The file needs to be in JSON Lines format, containing an entry per user with the following format:

{"userKey": <user-key>, "customProperties": <json-object>}

For example:

{"userKey": "1234", "customProperties": {"favoriteColor": "blue"}}

To reduce the size of file transfers, Kevel recommends delivering the file gzipped. With this compression, the file extension must end in gz or gzip, e.g., static-audiences.jsonl.gz.

All user custom properties found in the file will be considered and saved as static. See the Configure user custom properties endpoint for more details on how to manage the set of static audiences and Static Audiences page for more details on this feature.

post/forecaster/udb/custom-properties/ingest-url

Request

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

Request body

filenamestring

The name of the file to be pushed to the ingest URL.

Response

Normal response, containing a JSON object with the signed Amazon S3 URL

urlstring

The signed URL for the Amazon S3 Bucket to where the file can be uploaded.

statusstring

A fully-formed URL you can GET to track the ingestion status of this upload. The URL points at /forecaster/udb/ingest-status with the appropriate type and file query parameters already filled in.

Changes

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