business

Get forecasts

Get one forecast by its id or forecast key: the business profile it forecasts, whether it is that profile's current forecast, and its demand trends. Read it inside its profile with business_profiles_get_v2, tab forecasts and this forecastKey.

get/api/v1/business/forecasts/{id}

Request

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

The forecast's id or forecast key

Headers

Point11-Organizationstring uuid

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

Response

Success.

idstring uuid required
forecastKeystring required
versioninteger required
status'active' | 'archived' | 'deleted' required
currentboolean required
contentLanguage'en' | 'fr' | 'es' | 'de' | 'pt' | 'ja' | 'it' | 'nl' | 'sv' | 'cs' | 'pl' | 'tr' | 'ru' | 'zh-Hans' | 'ko' | 'ar' required
createdAtstring date-time required
businessProfileIdstring uuid required
profileKeystring required

Changes

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