business

List goal subjects

List what a business profile can set a goal on: each metric with the campaign, Google Ads account, or website it reads, that subject's current reading (its low and high equal its value: no reading carries a margin of error), and, for Discovery brand win rate with Tools › Products market assumptions, the modeled annual value of one point.

get/api/v1/business/goal-subjects

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/goal-subjects
  • 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)

Query parameters

limitinteger

Number of items to return (1–1000)

cursorstring

Opaque cursor returned as nextCursor by the previous page

businessProfileIdstring uuid required
readingsboolean

False lists the subjects without reading them, each current and onePointUsd null, so a form can offer every subject and read only the one chosen. Default true.

metric'discovery_brand_win_rate' | 'discovery_brand_share' | 'experience_pass_rate' | 'inspector_score' | 'google_ads_quality_score'

Narrow the list to the one subject this metric reads with campaignId or googleAdsAccountId (absent where the metric reads neither).

campaignIdstring uuid

The narrowed subject's campaign; needs metric.

googleAdsAccountIdstring uuid

The narrowed subject's Google Ads account; needs metric.

Headers

Point11-Organizationstring uuid

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

Response

Success.

nextCursorstring nullable required

Changes

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