API reference/Kits

Get pipeline totals

Try it

Read kit counts and booked revenue, excluding pitched deals from booked revenue. This is an aggregate SQL read.

GET/api/v1/pipeline

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

kits:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

No input parameters.

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{}

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "counts": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "number"
      }
    },
    "bookedRevenue": {
      "type": "number"
    }
  },
  "required": [
    "counts",
    "bookedRevenue"
  ],
  "additionalProperties": false
}