business

Get customer explorer reports

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.

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)

Path parameters

id'organization' required

Query parameters

job_mixstring[]

Only customers in these job_mix groups (their catalogIds)

audience_mixstring[]

Only customers in these audience_mix groups (their catalogIds)

channel_mixstring[]

Only customers in these channel_mix groups (their catalogIds)

revenue_mixstring[]

Only customers in these revenue_mix groups (their catalogIds)

intent_stage_mixstring[]

Only customers in these intent_stage_mix groups (their catalogIds)

age_mixstring[]

Only customers in these age_mix groups (their catalogIds)

gender_mixstring[]

Only customers in these gender_mix groups (their catalogIds)

education_mixstring[]

Only customers in these education_mix groups (their catalogIds)

household_income_mixstring[]

Only customers in these household_income_mix groups (their catalogIds)

urbanicity_mixstring[]

Only customers in these urbanicity_mix groups (their catalogIds)

regional_mixstring[]

Only customers in these regional_mix groups (their catalogIds)

life_stage_mixstring[]

Only customers in these life_stage_mix groups (their catalogIds)

language_mixstring[]

Only customers in these language_mix groups (their catalogIds)

occupation_mixstring[]

Only customers in these occupation_mix groups (their catalogIds)

company_size_mixstring[]

Only customers in these company_size_mix groups (their catalogIds)

buyer_role_mixstring[]

Only customers in these buyer_role_mix groups (their catalogIds)

countrystring

Only customers in this country (ISO 3166-1 alpha-2)

regionstring

Only customers in this region (ISO 3166-2, for example US-CA)

postalCodesboolean

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-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

Changes

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