Measure API Endpoints Documentation

Update Forecast

Purpose

Enable developers to update a forecast card in Test Center with your own data, instead of using the default Prophet forecast.

Type of Request: POST

URL: https://www.prototypr.ai/api/v1/update-forecast

Headers

• Authentication: Bearer ${TOKEN}
• Content-Type: application/json
• Accept: application/json

Request Body

• user_id: String

  This is your prototypr.ai user_id

• workspace_id: String

  This is your prototypr.ai workspace_id

• card_id: String

  This is the forecast card you want to update in /test-center

• dates: List of Strings

  Must be formatted as "yyyy-mm-dd". The first date in the list must be the start of the current quarter. The last date must be the last date of the current quarter.

• values: Float or Int

  A list of forecasted values for the current quarter. The length of the list must equal the number of days between the first and last day of the current quarter

import requests
import os
import json

url = "https://www.prototypr.ai/api/v1/update-forecast"
payload = {
    "user_id": "your_user_id",
    "workspace_id": "your_workspace_id",
    "card_id": "your_forecast_card_id",
    "forecastData": {
        "dates": list_of_forecast_dates,
        "values": list_of_forecast_values
    }

}
headers = {
    "Authorization": "Bearer " + os.getenv("API_KEY"),
    "Content-Type": "application/json",
    "Accept": "application/json"
}

response = requests.post(url, data=json.dumps(payload), headers=headers)
print(response.json())
                                

{ "data": {
    "log":
      {
        "request_count": "1",
        "request_date": "2024-05-07 11:41:18",
        "request_id": "71a6c2e84b694cfff2b92fdfa23",
        "service": "update forecast",
      },
    "message": "forecast saved"
    }
}