cohorts

Create a cohort

Creates an empty cohort. Uploading members or submitting a query renews the expiry using the configured retention period.

post/cohorts

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/cohorts
  • Auth: API key in header x-api-key

Headers

Idempotency-Keystring uuid required

Required UUID that makes the mutation safely retriable. Replaying the same key with the same body returns the original resource with the X-Idempotent-Replay and Idempotent-Replayed headers; replaying it with a different body returns 422 IDEMPOTENCY_KEY_PAYLOAD_MISMATCH.

Request body

namestring

Optional label, up to 120 characters.

retention_daysinteger

How long cohort membership is retained before automatic purge.

Response

Cohort created

cachedboolean
credits_remaininginteger nullable
credits_usedinteger
endpointstring
platformstring
request_idstring
successboolean

Example response

{
  "data": {
    "retention_days": 30
  },
  "platform": "cohorts",
  "success": true
}

Changes

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