journeyPlanSummary

Requires permission visits:journey-plan:manage.

Returns journey plan totals over a date range: plans, planned stops and completed stops, counted over the whole range. Requires permission to manage journey plans.

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 JourneyPlanSummary($dateFrom: DateTime!, $dateTo: DateTime!) {
  journeyPlanSummary(dateFrom: $dateFrom, dateTo: $dateTo) {
    completedStops
    plans
    stops
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query JourneyPlanSummary($dateFrom: DateTime!, $dateTo: DateTime!) {\n  journeyPlanSummary(dateFrom: $dateFrom, dateTo: $dateTo) {\n    completedStops\n    plans\n    stops\n  }\n}",
  "variables": {
    "dateFrom": "2025-01-15T00:00:00Z",
    "dateTo": "2025-01-15T00:00:00Z"
  }
}
EOF

Variables:

{
  "dateFrom": "2025-01-15T00:00:00Z",
  "dateTo": "2025-01-15T00:00:00Z"
}

Response:

{
  "data": {
    "journeyPlanSummary": {
      "completedStops": 0,
      "plans": 0,
      "stops": 0
    }
  }
}

journeyPlanSummary(
  dateFrom: DateTime!
  dateTo: DateTime!
  salesRepId: ID
): JourneyPlanListSummary!

Arguments

journeyPlanSummary.dateFrom ● DateTime! non-null scalar

The first day of the range.

journeyPlanSummary.dateTo ● DateTime! non-null scalar

The last day of the range.

journeyPlanSummary.salesRepId ● ID scalar

The ID of the sales rep to total plans for. Omit it for every rep.

Type

JourneyPlanListSummary object

Totals of the route planning list, counted over the whole date range.