GET
/
api
/
v1
/
analytics
Retrieve analytics data
curl --request GET \
  --url https://api.fleetworks.ai/api/v1/analytics \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "date": "2023-11-07T05:31:56Z",
      "metrics": {
        "totalCalls": 123,
        "successfulCalls": 123,
        "averageCallDuration": 123,
        "totalBids": 123,
        "acceptedBids": 123
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.

Query Parameters

​
startDate
string<date>
required

Start date for analytics data.

​
endDate
string<date>
required

End date for analytics data.

​
metric
enum<string>

Specific metric to retrieve.

Available options:
average_rate,
avg_call_duration,
total_bids,
call_volume,
loads_touched,
loads_booked

Response

200
application/json

Successful retrieval of analytics data.

The response is of type object.