---
title: "Get customer explorer reports"
method: GET
path: "/api/v1/business/customer-explorer-reports/{id}"
tags: ["business"]
---

# Get customer explorer reports

`GET /api/v1/business/customer-explorer-reports/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/customer-explorer-reports/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Get the customer overview for the organization or one business profile (pass id "organization"): how the active pool splits by segment, location, and audience, for the Customers overview.

## Path parameters

- `id` 'organization', required

## Query parameters

- `job_mix` string[]: Only customers in these job_mix groups (their catalogIds)
- `audience_mix` string[]: Only customers in these audience_mix groups (their catalogIds)
- `channel_mix` string[]: Only customers in these channel_mix groups (their catalogIds)
- `revenue_mix` string[]: Only customers in these revenue_mix groups (their catalogIds)
- `intent_stage_mix` string[]: Only customers in these intent_stage_mix groups (their catalogIds)
- `age_mix` string[]: Only customers in these age_mix groups (their catalogIds)
- `gender_mix` string[]: Only customers in these gender_mix groups (their catalogIds)
- `education_mix` string[]: Only customers in these education_mix groups (their catalogIds)
- `household_income_mix` string[]: Only customers in these household_income_mix groups (their catalogIds)
- `urbanicity_mix` string[]: Only customers in these urbanicity_mix groups (their catalogIds)
- `regional_mix` string[]: Only customers in these regional_mix groups (their catalogIds)
- `life_stage_mix` string[]: Only customers in these life_stage_mix groups (their catalogIds)
- `language_mix` string[]: Only customers in these language_mix groups (their catalogIds)
- `occupation_mix` string[]: Only customers in these occupation_mix groups (their catalogIds)
- `company_size_mix` string[]: Only customers in these company_size_mix groups (their catalogIds)
- `buyer_role_mix` string[]: Only customers in these buyer_role_mix groups (their catalogIds)
- `country` string: Only customers in this country (ISO 3166-1 alpha-2)
- `region` string: Only customers in this region (ISO 3166-2, for example US-CA)
- `postalCodes` boolean: false reads geography down to states and provinces, for a caller that draws no postal code: no postal node. Omit it, or pass true, for each US customer's postal code too.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- BusinessCustomerExplorerReportsGetResponse
  - `model` BusinessModel, required
    - `dimensions` object[], required
      - `id` 'job_mix' | 'audience_mix' | 'channel_mix' | 'revenue_mix' | 'intent_stage_mix' | 'age_mix' | 'gender_mix' | 'education_mix' | 'household_income_mix' | 'urbanicity_mix' | 'regional_mix' | 'life_stage_mix' | 'language_mix' | 'occupation_mix' | 'company_size_mix' | 'buyer_role_mix', required
      - `label` string, required
      - `buckets` object[], required
        - `label` string, required
        - `bucketIds` string[], required
        - `catalogIds` string[], required
        - `customerCount` integer, required
        - `displayOrder` integer, nullable, required
      - `assignedCount` integer, required
      - `unmodeledCount` integer, required
      - `absentFromProfile` boolean, required
    - `geography` object, required
      - `nodes` object[], required
        - `id` string, required
        - `parentId` string, nullable, required
        - `childIds` string[], required
        - `level` 'country' | 'admin1' | 'postal', required
        - `label` string, required
        - `regionCode` string, required
        - `resolution` 'countries' | 'provinces' | 'postal', required
        - `countryCode` string, required
        - `admin1Code` string, nullable, required
        - `subdivisionCodes` string[], required
        - `displayName` string, nullable, required
        - `customerCount` integer, required
      - `totalCustomerCount` integer, required
    - `activeCount` integer, required
    - `retiredCount` integer, required
    - `audienceType` 'b2b' | 'b2c' | 'prosumer' | 'mixed', nullable, required
  - `baseline` BusinessModel, required
    - `dimensions` object[], required
      - `id` 'job_mix' | 'audience_mix' | 'channel_mix' | 'revenue_mix' | 'intent_stage_mix' | 'age_mix' | 'gender_mix' | 'education_mix' | 'household_income_mix' | 'urbanicity_mix' | 'regional_mix' | 'life_stage_mix' | 'language_mix' | 'occupation_mix' | 'company_size_mix' | 'buyer_role_mix', required
      - `label` string, required
      - `buckets` object[], required
        - `label` string, required
        - `bucketIds` string[], required
        - `catalogIds` string[], required
        - `customerCount` integer, required
        - `displayOrder` integer, nullable, required
      - `assignedCount` integer, required
      - `unmodeledCount` integer, required
      - `absentFromProfile` boolean, required
    - `geography` object, required
      - `nodes` object[], required
        - `id` string, required
        - `parentId` string, nullable, required
        - `childIds` string[], required
        - `level` 'country' | 'admin1' | 'postal', required
        - `label` string, required
        - `regionCode` string, required
        - `resolution` 'countries' | 'provinces' | 'postal', required
        - `countryCode` string, required
        - `admin1Code` string, nullable, required
        - `subdivisionCodes` string[], required
        - `displayName` string, nullable, required
        - `customerCount` integer, required
      - `totalCustomerCount` integer, required
    - `activeCount` integer, required
    - `retiredCount` integer, required
    - `audienceType` 'b2b' | 'b2c' | 'prosumer' | 'mixed', nullable, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)