List wave plans

Parameters

locationIdquerystring

planDatequerystring

limitqueryinteger

Responses

200Plans, newest day first

dataobject[]required

idstring (uuid)required

locationIdstring (uuid)required

planDatestringrequired

horizonStartstringrequired

horizonEndstringrequired

statusenumrequired

draftcommittedsuperseded

sourceenumrequired

manualscheduledapi

assumptionsobjectrequired

summaryobjectrequired

diagnosticsobjectrequired

accuracyobjectrequired

committedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/plans' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/plans", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/plans",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "data": [
    {
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "planDate": "plan date",
      "horizonStart": "horizon start",
      "horizonEnd": "horizon end",
      "status": "draft",
      "source": "manual",
      "assumptions": {},
      "summary": {},
      "diagnostics": {},
      "accuracy": {},
      "committedAt": "committed at",
      "createdAt": "created at",
      "updatedAt": "updated at"
    }
  ]
}