routePlanningRuns

Requires permission visits:journey-plan:manage.

Lists recent planning runs, newest first, showing only the reps in your team. 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 RoutePlanningRuns {
  routePlanningRuns {
    id
    actorName
    actorUserId
    endDate
    finishedAt
    isPreview
    reps {
      repName
      status
      added
      addedMissed
      addedNewCustomers
      addedVisitIds
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query RoutePlanningRuns {\n  routePlanningRuns {\n    id\n    actorName\n    actorUserId\n    endDate\n    finishedAt\n    isPreview\n    reps {\n      repName\n      status\n      added\n      addedMissed\n      addedNewCustomers\n      addedVisitIds\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "routePlanningRuns": [
      {
        "id": "id",
        "actorName": "string",
        "actorUserId": "id",
        "endDate": "2025-01-15T00:00:00Z",
        "finishedAt": "2025-01-15T00:00:00Z",
        "isPreview": true,
        "reps": [
          {
            "repName": "string",
            "status": "FAILED",
            "added": 0,
            "addedMissed": 0,
            "addedNewCustomers": 0,
            "addedVisitIds": [
              "id"
            ]
          }
        ]
      }
    ]
  }
}

routePlanningRuns(
  limit: Int
): [RoutePlanningRun!]!

Arguments

routePlanningRuns.limit ● Int scalar

How many runs to return, at most 50. Omit it for 20.

Type

RoutePlanningRun object

A planning run, or a preview of one.