Dashboard Analytics
Getting Started
Authenticate using the Login API to obtain an access token. Include the returned Bearer Token in the Authorization header and provide a unique X-Device-ID with all authenticated requests. All requests must be made over HTTPS and are subject to rate limits.
Base URL: https://insprl.com/api
POST /external/analytics/dashboard
Use the Dashboard Analytics API to retrieve an overview of your SPRL account performance.
This endpoint provides account-level statistics, link activity, engagement metrics, and recent performance insights, making it ideal for dashboards, browser extensions, WordPress plugins, mobile applications, and automation platforms.
Request Information
| Method | POST |
| API Endpoint | https://insprl.com/api/external/analytics/dashboard |
| Authentication | Required |
Header Parameters
| Parameter | Type | Description |
|---|
| Authorization | String | Bearer authentication token received from the Login API. |
| X-Device-ID | String | The same device identifier used during login. |
| Content-Type | JSON | application/json |
Request Parameters
| Parameter | Type | Validate | Description |
|---|
| No request parameters required. |
Response Parameters
| Parameter | Type | Description |
|---|
| success | Boolean | Request status (true/false). |
| data | Object | Dashboard analytics summary. |
| data.total_urls | Integer | Total URLs owned by the account. |
| data.active_urls | Integer | Total active URLs. |
| data.total_clicks | Integer | Total clicks across all URLs. |
| data.unique_visitors | Integer | Total unique visitors. |
| data.trending_urls | Integer | Total URLs currently marked as trending. |
| data.last_click_at | DateTime | Most recent click activity. |
Response Codes
| SPRL Code | HTTP Status | Mode | Response Field | Description |
| 100 | 200 | success | data | Request processed successfully. |
| 101 | 401 | failed | message | Authentication failed. Invalid session, token or credentials. |
| 102 | 422 | failed | errors | Parameter validation failed. Check the request fields. |
| 103 | 404 | failed | message | Requested resource was not found. |
| 104 | 403 | failed | message | Access denied or account restricted. |
| 105 | 429 | failed | message | Too many requests. Please retry later. |
| 106 | 500 | failed | message | Unexpected server error. Please try again later. |
Error Flag Reference
| Category | Flag | Type | Description |
| Authentication | INVALID_SESSION | auth_error | The supplied token or device identifier is invalid. |
| Authentication | INVALID_CREDENTIALS | auth_error | Invalid login credentials supplied. |
| Validation | INVALID_PARAMETER | validation_error | One or more request parameters are invalid. |
| Resource | RESOURCE_NOT_FOUND | resource_error | The requested URL, folder, domain or resource could not be found. |
| Account | ACCOUNT_RESTRICTED | account_error | The account is restricted or access has been denied. |
| Rate Limit | RATE_LIMIT_EXCEEDED | rate_limit_exceeded | The request rate limit has been exceeded. |
| Server | UNEXPECTED_ERROR | server_error | An unexpected internal server error occurred. |