Route Summary Report

post

https://{dc-region}.zuperpro.com/api/reports/routes/summary

Generate a comprehensive routes summary report with detailed filtering options

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific route UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.status

string

Route status (active/inactive/completed)

filter.assigned_to

string

Assigned user UIDs (comma-separated)

filter.created_by

string

Creator user UIDs (comma-separated)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.route_date

string

Filter by route date

filter.route_uid

string

Route UIDs (comma-separated)

filter.keyword

string

Search keyword

filter.is_deleted

boolean

Is route deleted

filter.is_active

boolean

Is route active

filter.name

string

Route names (comma-separated)

filter.description

string

Route descriptions (comma-separated)

filter.start_location

string

Start location UIDs (comma-separated)

filter.end_location

string

End location UIDs (comma-separated)

filter.estimated_distance_min

number

Minimum estimated distance

filter.estimated_distance_max

number

Maximum estimated distance

filter.actual_distance_min

number

Minimum actual distance

filter.actual_distance_max

number

Maximum actual distance

filter.estimated_duration_min

number

Minimum estimated duration (minutes)

filter.estimated_duration_max

number

Maximum estimated duration (minutes)

filter.actual_duration_min

number

Minimum actual duration (minutes)

filter.actual_duration_max

number

Maximum actual duration (minutes)

filter.job_count_min

number

Minimum job count

filter.job_count_max

number

Maximum job count

filter.completed_job_count_min

number

Minimum completed job count

filter.completed_job_count_max

number

Maximum completed job count

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Routes Summary report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication