campaigns

Get precision quotes

Price an order that raises one reading of a campaign (id) to Standard precision (±5 points): pass the reading's group (cohort: the whole campaign, its attribute buckets, or an outcome) and its customers. A campaign that takes no order is refused (409, its product's reason and next step in details.control); otherwise returns its product's verdict (control), the customers one order adds (eligible existing customers inside the group first, the rest generated, within the campaign's limits), the margin they reach, and every monthly and one-time charge; place it with campaigns_precision_orders_start.

get/api/v1/campaigns/precision-quotes/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/precision-quotes/{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

idstring uuid required

The campaign id.

Query parameters

cohort'campaign' | 'attribute' | 'outcome' required

What the reading counts: the whole campaign, attribute buckets, or an outcome.

bucketsstring[]

The group's buckets (an outcome's within), each "<dimensionId>:<bucketId>", one per dimension: audience_mix:<id>, store:<location key>.

customersinteger required

The reading's customers: the distinct customers behind its value in its span.

outcomeOfinteger

For an outcome: the distinct customers, in the same span, of what it sits in (the campaign, or its buckets).

Headers

Point11-Organizationstring uuid

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

Response

Success.

campaignCustomersinteger required

The roster the order grows.

filledinteger required

Of them, eligible customers already in the organization, admitted at once.

generatedinteger required

Of them, customers generated for the order.

Changes

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