quoteListSummary

Requires permission sales:quote:read.

Totals for the quote list KPI strip. Takes the same filter as quotesPaginated and totals the whole filtered set in the organization's base currency.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query QuoteListSummary {
  quoteListSummary {
    decidedCount
    expiringSoonCount
    pendingCount
    totalCount
    totalValue
    winRate
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query QuoteListSummary {\n  quoteListSummary {\n    decidedCount\n    expiringSoonCount\n    pendingCount\n    totalCount\n    totalValue\n    winRate\n  }\n}"
}
EOF

Response:

{
  "data": {
    "quoteListSummary": {
      "decidedCount": 0,
      "expiringSoonCount": 0,
      "pendingCount": 0,
      "totalCount": 0,
      "totalValue": 0,
      "winRate": 0
    }
  }
}

quoteListSummary(
  filter: QuoteFilterInput
): QuoteListSummary!

Arguments

quoteListSummary.filter ● QuoteFilterInput input

The same filters as quotesPaginated. Totals cover every quote that matches.

Type

QuoteListSummary object

Headline figures for the quotes matching a filter.