business

List goals

List a business profile's goals (by its id or profile key, or "default" for the one business_profile_selections_get selects by default), oldest first: each goal's metric, target and due date, the reading it started from, the metric's current reading and history from the product that owns it, and its status (reached, on track, behind, below target for an ongoing goal or one with no baseline to pace from, missed, stale, or no reading yet; within_margin is no goal's status any more, since no reading carries a margin of error, and each reading's low and high equal its value). Archived goals are included only when includeArchived is true.

get/api/v1/business/goals

Request

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

The business profile: its id or profile key, or "default" for the profile business.profile-selections.get.v1 selects by default

includeArchivedboolean

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.