Retrieve the statistics of your account for a period of time: lead and event counts, conversion rates, sales totals, averages and survey scores. These are the same statistics shown on your dashboard.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/stats | Dashboard Stats: Full Access | WP/API |
Base URL: https://rental.software/api6. Every request needs your apiKey.
GET /stats
Request Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| start | Unix timestamp | 30 days ago | Start of the statistics window |
| end | Unix timestamp | Now | End of the statistics window. It must be later than start. If it is not, now is used instead |
Response Schema
The response is sent in JSON format and lists all available statistic names and formatted values. For example, dollar amounts return with dollar signs and decimals.
Example Request
curl "https://rental.software/api6/stats?apiKey=YOUR_API_KEY&start=1721326143&end=1721412543"
Example Responses
Successful response:
200 OK
Content-Type: application/json
{
"Total Leads": "3261",
"Total Events": "79",
"Conversion Rate": "2.4%",
"Total Web Leads": "367",
"Total Web Events": "3",
"Web Conversion Rate": "0.8%",
"Total Sales": "$3,238.67",
"Avg Event": "$41.00",
"Avg Distance": "$0.00",
"% Discounts": "0%",
"Avg Rentals/Event": 3.4,
"Avg Rental $/Event": "$26.06",
"Avg Book Days": 36,
"Avg Look Days": 31,
"Autobook Total": "0",
"Autobook %": "0%",
"Pct Repeat": "0%",
"Pct Repeat All": "2.6%",
"Adwords Customers": "76",
"Adwords Events": "0",
"Adwords Total": "$0.00",
"Facebook Customers": "26",
"Facebook Events": "0",
"Facebook Total": "$0.00",
"Survey: Would Rent Again": "N/A",
"Survey: Booking Process": 0,
"Survey: Customer Service": 0,
"Survey: Friendliness": 0,
"Survey: Competence": 0,
"Survey: Promptness": 0,
"request_time": 1721324921
}Error responses:
405 Method Not Allowed
Content-Type: application/json
{
"status": 405,
"message": "Only accepts GET requests"
}403 Forbidden
Content-Type: application/json
{
"status": 403,
"message": "Permission access restricted. Dashboard Stats Full Access Required."
}Good to Know
- The values are formatted for display. Amounts are text with a currency sign and thousands separators ("$3,238.67") and rates are text with a percent sign ("2.4%"). Remove the formatting before doing math with them.
- The statistics cover your whole account.
- To grant the permission, open the API key under Settings > API Keys and set Dashboard Stats to Full Access.