GET /v1/crm/analytics/deal-summary

GET/v1/crm/analytics/deal-summary

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

windowstring

Window: 7, 30, or 90

default: "7"

Responses

200OK

cur_lostinteger<int64>required

cur_woninteger<int64>required

cur_won_valueinteger<int64>required

lost_pct_changenumber<double> | nullrequired

open_valueinteger<int64>required

prev_lostinteger<int64>required

prev_woninteger<int64>required

weighted_valueinteger<int64>required

won_pct_changenumber<double> | nullrequired

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/deal-summary"

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

import requests

response = requests.get(
    "/v1/crm/analytics/deal-summary",
)

Response

{
  "cur_lost": 0,
  "cur_won": 0,
  "cur_won_value": 0,
  "lost_pct_change": 0,
  "open_value": 0,
  "prev_lost": 0,
  "prev_won": 0,
  "weighted_value": 0,
  "won_pct_change": 0
}

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