business

Create goals

Set a goal: a target for one metric of a business profile, by a due date or ongoing (no due date: a target to reach and keep). Discovery brand win rate, Discovery brand share, and Experience journey pass rate name their campaign; Google Ads Quality Score names its account; Inspector score reads the profile's website. business_goal_subjects_list lists what the profile can set a goal on. The goal records the metric's current reading as its baseline.

post/api/v1/business/goals/create

Request

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

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

businessProfileIdstring uuid required
metric'discovery_brand_win_rate' | 'discovery_brand_share' | 'experience_pass_rate' | 'inspector_score' | 'google_ads_quality_score' required
campaignIdstring uuid nullable
googleAdsAccountIdstring uuid nullable
targetValuenumber required
dueOnstring date nullable required

The last day of the goal, YYYY-MM-DD; null for an ongoing goal with no deadline

Response

Success.

Changes

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