Public API Specs

Collective[i] Public API

Collective[i] Public API

Access insights from Collective[i]'s public API.

Table of Contents

Forecast

Forecast

get /api/v1/clients/{client_id}/insights/forecast
Get forecast insights for a client (apiV1ClientsClientIdInsightsForecastGet)

Path parameters

client_id (required)
Path Parameter — The ID of the client to retrieve forecast for. format: uuid

Query parameters

time_window (required)
Query Parameter — The time window of the insights being returned (month, quarter, year, all)

Return type

Forecast

Example data

Content-Type: application/json
{
  "revenue_units" : "revenue_units",
  "forecast_window" : {
    "month" : {
      "change_percentage" : 6.0274563,
      "predicted_revenue" : 0.8008282
    },
    "year" : {
      "change_percentage" : 6.0274563,
      "predicted_revenue" : 0.8008282
    },
    "quarter" : {
      "change_percentage" : 6.0274563,
      "predicted_revenue" : 0.8008282
    }
  },
  "client_name" : "client_name",
  "client_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Revenue forecast for the requested time windows.

400

Bad Request

401

Unauthorized

403

Forbidden

404

NotFound

500

InternalServerError