alpha

Get advisor settings (v4)

Get Advisor's organization-wide settings (id "organization"), which every campaign of every product runs with: when Advisor reviews the list (monthly or weekly), the priorities it weighs, autotracking (off; suggest, where a met website check asks a person to confirm; or complete, where it completes the action), and listSize, how many open actions each review keeps on the list (3, 5, 10, 15 or 20; the rest are set aside, still listed), as the current revision with who saved it and when, and the newest 50 revisions as history, newest first. Revision 0 is the product defaults (monthly, no priorities, autotracking off, 5 actions), before the organization's first save.

get/api/v1/alpha/advisor-settings-v4/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/advisor-settings-v4/{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

"organization", Advisor's one org-wide scope

Headers

Point11-Organizationstring uuid

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

Response

Success.

id'organization' required

"organization", Advisor's one org-wide scope

refreshInterval'weekly' | 'monthly' required

When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday

prioritiesstring nullable required

What Advisor weighs, and sets aside what conflicts with; null is none

implementationTracking'off' | 'suggest' | 'complete' required

Autotracking: off; suggest (Alpha checks the public website and a met check asks a person to confirm the action is done); complete (a met check completes an action whose status no person has set)

listSize3 | 5 | 10 | 15 | 20 required

How many open actions Advisor keeps on the list: each review places that many, the largest opportunities first, and sets the rest aside, still listed

revisioninteger required

The current revision; 0 before the first save, when the product defaults run

savedAtstring date-time nullable required

When the current revision was saved; null before any

Changes

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