business

Get campaign pool counts

Count the customers a new campaign on a business profile would target (id "organization"): the profile's eligible customers, narrowed to audiences, or with targetKind physical_locations every customer of its current stores. 0 when the profile cannot launch campaigns.

get/api/v1/business/campaign-pool-counts/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/campaign-pool-counts/{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

The literal "organization".

Query parameters

businessProfileIdstring uuid required

The business profile.

audienceIdsstring[]

Narrow to these audiences.

targetKind'profile' | 'physical_locations'

physical_locations counts every customer of the profile's current stores.

includeStoreCustomersboolean

Also admit the profile's store customers, as a Research campaign does.

Headers

Point11-Organizationstring uuid

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

Response

Success.

countinteger required

Changes

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