DoRoutes API · version 1

Reports

GET/v1/admin/reports/stats/jobs

Job figures

Needs the reports.read permission.

Parameters

fromstring, in the query
First day, YYYY-MM-DD.
tostring, in the query
Last day, YYYY-MM-DD.
statusstring, in the query

Response 200 · object

Done.

job_statsJobStats, required
- total_jobsnumber
- average_durationnumber
- average_distancenumber
- average_lead_timenumber
- average_grand_totalnumber
  Pence.
- overall_grand_totalnumber
  Pence.
- average_costnumber
  Pence.
- overall_costnumber
  Pence.
- average_number_of_itemsnumber

Example response 200

{
  "job_stats": {
    "total_jobs": 0,
    "average_duration": 0,
    "average_distance": 0,
    "average_lead_time": 0,
    "average_grand_total": 0,
    "overall_grand_total": 0,
    "average_cost": 0,
    "overall_cost": 0,
    "average_number_of_items": 0
  }
}

Response 400 · Error

The request is not valid.

errorobject, required
- codestring, required
  A short machine-readable name, such as not_found.
- messagestring, required
  What went wrong, for people.
request_idstring, required
Matches the X-Request-ID response header.

Example response 400

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "request_id": "string"
}

Response 401 · Error

No tenant key, or no valid session.

Fields as in Job figures

Response 403 · Error

The session may not do this.

Fields as in Job figures

Response 404 · Error

Not found, or not yours.

Fields as in Job figures

Response 500 · Error

Something failed on our side.

Fields as in Job figures

GET/v1/admin/reports/stats/quotes

Quote figures

Needs the reports.read permission.

Parameters

fromstring, in the query
First day, YYYY-MM-DD.
tostring, in the query
Last day, YYYY-MM-DD.
statusstring, in the query

Response 200 · object

Done.

quote_statsQuoteStats, required
- total_quotesnumber
- average_durationnumber
- average_distancenumber
- average_lead_timenumber
- average_grand_totalnumber
  Pence.
- overall_grand_totalnumber
  Pence.
- average_costnumber
  Pence.
- overall_costnumber
  Pence.
- average_number_of_itemsnumber

Example response 200

{
  "quote_stats": {
    "total_quotes": 0,
    "average_duration": 0,
    "average_distance": 0,
    "average_lead_time": 0,
    "average_grand_total": 0,
    "overall_grand_total": 0,
    "average_cost": 0,
    "overall_cost": 0,
    "average_number_of_items": 0
  }
}

Response 400 · Error

The request is not valid.

Fields as in Job figures

Response 401 · Error

No tenant key, or no valid session.

Fields as in Job figures

Response 403 · Error

The session may not do this.

Fields as in Job figures

Response 404 · Error

Not found, or not yours.

Fields as in Job figures

Response 500 · Error

Something failed on our side.

Fields as in Job figures

GET/v1/admin/reports/stats/customers

Customer figures

Needs the reports.read permission.

Parameters

fromstring, in the query
First day, YYYY-MM-DD.
tostring, in the query
Last day, YYYY-MM-DD.
statusstring, in the query

Response 200 · object

Done.

customer_statsCustomerStats, required
- total_customersnumber
- average_lifetime_valuenumber
  Pence.
- total_revenuenumber
  Pence.
- average_order_valuenumber
- average_number_of_jobsnumber
- average_number_of_quotesnumber

Example response 200

{
  "customer_stats": {
    "total_customers": 0,
    "average_lifetime_value": 0,
    "total_revenue": 0,
    "average_order_value": 0,
    "average_number_of_jobs": 0,
    "average_number_of_quotes": 0
  }
}

Response 400 · Error

The request is not valid.

Fields as in Job figures

Response 401 · Error

No tenant key, or no valid session.

Fields as in Job figures

Response 403 · Error

The session may not do this.

Fields as in Job figures

Response 404 · Error

Not found, or not yours.

Fields as in Job figures

Response 500 · Error

Something failed on our side.

Fields as in Job figures