# Audience Overlap

Compare audience overlap between 2-10 creators on a given platform.
**What you get**
- Returns per-creator audience overlap and unique audience percentages, plus report-level totals (total followers and total unique followers across all compared creators).
- Useful for evaluating creator partnerships, identifying audience duplication across campaigns, and optimizing influencer selection for maximum reach.

**Credits**
- 1 credit per request, regardless of how many creators are compared.

Endpoint: POST /public/v1/creators/audience/overlap/
Version: 1.0.0
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer API_KEY

## Request fields (application/json):

  - `platform` (string, required)

  - `creators` (array, required)

## Response 200 fields (application/json):

  - `credits_cost` (number)
    Example: 1

  - `credits_left` (number)

  - `status` (boolean)

  - `success` (boolean)

  - `basics` (object)

  - `basics.total_followers` (integer)

  - `basics.total_unique_followers` (integer)

  - `details` (array)

  - `details.user` (object, required)

  - `details.user.user_id` (string)
    The creator's unique platform identifier.

  - `details.user.username` (string)
    The creator's username on the platform.

  - `details.user.followers` (integer)

  - `details.user.fullname` (string)

  - `details.user.url` (string)
    The creator's profile URL.

  - `details.user.is_verified` (boolean)

  - `details.user.engagements` (integer)

  - `details.user.stats` (array)

  - `details.user.stats.post_type` (string)

  - `details.user.stats.engagements` (integer)

  - `details.user_id` (string, required)
    The creator's unique platform identifier.

  - `details.username` (string, required)
    The creator's username on the platform.

  - `details.followers` (integer, required)

  - `details.unique_percentage` (number, required)

  - `details.overlapping_percentage` (number, required)

## Response 400:

  - `400` (unknown)
    Bad request — invalid input or unsupported state.

## Response 400 fields (application/json):

  - `error` (any)
    Human-readable description of what went wrong. Shape varies per endpoint: string on most paths, DRF field-error object on validation paths of creators_api enrich/* and enrichment_batch_api create, list of strings on discovery filter validation. See the per-endpoint example response.
    Example: Insufficient credits.

  - `error_code` (string, required)
    Machine-readable snake_case slug identifying the error class. Stable across API versions; **the only field guaranteed present on every public-API error**. Use for programmatic branching instead of parsing `error`.
    Example: insufficient_credits

  - `message` (string)
    Optional long-form detail sibling to `error`. Present on endpoints that historically returned both a short label and a long explanation (rate limits, polling, batch state, insufficient_credits on resume).
    Example: Poll every 30-60 seconds. Excessive polling results in rate limiting.

  - `retry_after` (integer)
    Seconds the caller should wait before retrying. Present on 429s where the OLD endpoint set it; mirrored in the `Retry-After` HTTP header.
    Example: 60

  - `response_meta` (object)
    Echo of request metadata on a few unwrapped endpoints (notably download_batch_enrichment_csv: batch_id, batch_status). Internal-only on wrapped endpoints; stripped before reaching the client.

  - `available_credits` (number)
    Credits currently available. Present on the 403 insufficient_credits response of `POST /public/v1/enrichment/batch/{id}/resume/`.

  - `required_minimum` (number)
    Minimum credits needed. Pairs with `available_credits`.

  - `current_status` (string)
    Current resource state. Present on 400 responses where the operation requires a different state (e.g. `batch_not_ready`, `batch_not_resumable`).

  - `active_batches` (integer)
    Active batch count when `error_code: batch_limit_reached`.

  - `max_allowed` (integer)
    Per-client batch ceiling. Pairs with `active_batches`.

## Response 401:

  - `401` (unknown)
    Unauthorized — missing or invalid API key.

## Response 403:

  - `403` (unknown)
    Forbidden — caller is not permitted to perform this action.

## Response 403 fields (application/json):

  - `error` (any)
    Human-readable description of what went wrong. Shape varies per endpoint: string on most paths, DRF field-error object on validation paths of creators_api enrich/* and enrichment_batch_api create, list of strings on discovery filter validation. See the per-endpoint example response.
    Example: Insufficient credits.

  - `error_code` (string, required)
    Machine-readable snake_case slug identifying the error class. Stable across API versions; **the only field guaranteed present on every public-API error**. Use for programmatic branching instead of parsing `error`.
    Example: insufficient_credits

  - `message` (string)
    Optional long-form detail sibling to `error`. Present on endpoints that historically returned both a short label and a long explanation (rate limits, polling, batch state, insufficient_credits on resume).
    Example: Poll every 30-60 seconds. Excessive polling results in rate limiting.

  - `retry_after` (integer)
    Seconds the caller should wait before retrying. Present on 429s where the OLD endpoint set it; mirrored in the `Retry-After` HTTP header.
    Example: 60

  - `response_meta` (object)
    Echo of request metadata on a few unwrapped endpoints (notably download_batch_enrichment_csv: batch_id, batch_status). Internal-only on wrapped endpoints; stripped before reaching the client.

  - `available_credits` (number)
    Credits currently available. Present on the 403 insufficient_credits response of `POST /public/v1/enrichment/batch/{id}/resume/`.

  - `required_minimum` (number)
    Minimum credits needed. Pairs with `available_credits`.

  - `current_status` (string)
    Current resource state. Present on 400 responses where the operation requires a different state (e.g. `batch_not_ready`, `batch_not_resumable`).

  - `active_batches` (integer)
    Active batch count when `error_code: batch_limit_reached`.

  - `max_allowed` (integer)
    Per-client batch ceiling. Pairs with `active_batches`.

## Response 422:

  - `422` (unknown)
    Unprocessable entity — validation failed.

## Response 429:

  - `429` (unknown)
    Too Many Requests — rate or capacity limit exceeded. Inspect the `Retry-After` header and the `retry_after` body field for the wait time in seconds.

## Response 429 fields (application/json):

  - `error` (any)
    Human-readable description of what went wrong. Shape varies per endpoint: string on most paths, DRF field-error object on validation paths of creators_api enrich/* and enrichment_batch_api create, list of strings on discovery filter validation. See the per-endpoint example response.
    Example: Insufficient credits.

  - `error_code` (string, required)
    Machine-readable snake_case slug identifying the error class. Stable across API versions; **the only field guaranteed present on every public-API error**. Use for programmatic branching instead of parsing `error`.
    Example: insufficient_credits

  - `message` (string)
    Optional long-form detail sibling to `error`. Present on endpoints that historically returned both a short label and a long explanation (rate limits, polling, batch state, insufficient_credits on resume).
    Example: Poll every 30-60 seconds. Excessive polling results in rate limiting.

  - `retry_after` (integer)
    Seconds the caller should wait before retrying. Present on 429s where the OLD endpoint set it; mirrored in the `Retry-After` HTTP header.
    Example: 60

  - `response_meta` (object)
    Echo of request metadata on a few unwrapped endpoints (notably download_batch_enrichment_csv: batch_id, batch_status). Internal-only on wrapped endpoints; stripped before reaching the client.

  - `available_credits` (number)
    Credits currently available. Present on the 403 insufficient_credits response of `POST /public/v1/enrichment/batch/{id}/resume/`.

  - `required_minimum` (number)
    Minimum credits needed. Pairs with `available_credits`.

  - `current_status` (string)
    Current resource state. Present on 400 responses where the operation requires a different state (e.g. `batch_not_ready`, `batch_not_resumable`).

  - `active_batches` (integer)
    Active batch count when `error_code: batch_limit_reached`.

  - `max_allowed` (integer)
    Per-client batch ceiling. Pairs with `active_batches`.