GET /v1/crm/analytics/pipeline

GET/v1/crm/analytics/pipeline

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsPipelineStage[] | nullrequired

Show properties

Array of PipelineStage

deal_countinteger<int64>required

stage_idstringrequired

stage_namestringrequired

stage_orderinteger<int32>required

total_valueinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/crm/analytics/pipeline"

const response = await fetch("/v1/crm/analytics/pipeline", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/crm/analytics/pipeline",
)

Response

{
  "items": [
    {
      "deal_count": 0,
      "stage_id": "string",
      "stage_name": "string",
      "stage_order": 0,
      "total_value": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}