SMLLR

Enterprise
API Reference

Programmatically integrate high-precision QR code analytics, dynamic link management, and multi-tier campaigns directly into your internal reporting dashboards.

Authentication

Secure your API requests using header-based tokens

All API requests require a valid Enterprise API key. You can pass your secure token in the headers of your request using either x-api-key or standard Authorization: Bearer formatting.

// Header Authentication Example
x-api-key: smllr_live_••••••••••••••••••••••••••••••••
// OR Authorization Header
Authorization: Bearer smllr_live_••••••••••••••••••••••••••••••••

Rate Limits & SLAs

Engineered for scale and enterprise reliability

60 / min
Standard rate limit per API token. Custom limits available.
< 150ms
Average global latency across distributed edge nodes.
99.99%
Backed by our strict Enterprise SLA uptime guarantee.

Endpoint Reference

GET

General Analytics Summary

https://www.smllr.app/api/v1/external/reporting/summary

Retrieve top-level scan summary metrics across all QR codes, campaigns, and clients within your organization. Filterable by date and aggregation period.

Request Parameters

periodstringOptional
Aggregation period: 'day', 'week', 'month', 'year'. Default is 'month'.
timeLineDatestringOptional
ISO date string representing the target timeframe.
timezoneOffsetnumberOptional
Client timezone offset in minutes. Default is 0.
Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/summary?period=month" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": {
    "totalScans": 14209,
    "uniqueVisitors": 9840,
    "topDevices": [{ "device": "Mobile", "count": 12100 }],
    "topCountries": [{ "country": "United States", "scans": 8400 }]
  }
}
GET

List All QR Codes

https://www.smllr.app/api/v1/external/reporting/qrs

Returns a complete list of all QR codes managed under your organization, including short URLs, destination links, total scan volumes, and creation dates.

Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/qrs" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": [
    {
      "id": "qr_123456",
      "title": "Summer Campaign Flyer",
      "shortUrl": "https://smllr.link/x9ab",
      "destinationUrl": "https://example.com/promo",
      "totalScans": 4120,
      "createdAt": "2026-05-01T12:00:00Z"
    }
  ]
}
GET

Specific QR Analytics

https://www.smllr.app/api/v1/external/reporting/qr/:id

Get detailed scan time-series data, granular geolocation breakdowns (city, region, country), device types, and referrers for a specific QR code.

Request Parameters

idstringRequired
Unique identifier of the target QR code.
periodstringOptional
Timeframe period: 'day', 'week', 'month', 'year'.
Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/qr/qr_123456?period=month" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": {
    "qrId": "qr_123456",
    "timeline": [{ "date": "2026-05-15", "scans": 340 }],
    "geolocation": [{ "city": "San Francisco", "region": "California", "country": "US", "scans": 210 }]
  }
}
GET

List All Campaigns

https://www.smllr.app/api/v1/external/reporting/campaigns

Retrieve all multi-QR marketing campaigns configured within your Enterprise account, providing aggregate scan volumes and QR counts.

Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/campaigns" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": [
    {
      "id": "camp_9876",
      "name": "Q3 Billboards",
      "qrCount": 12,
      "totalScans": 28900
    }
  ]
}
GET

Specific Campaign Analytics

https://www.smllr.app/api/v1/external/reporting/campaign/:id

Fetch comprehensive aggregated reporting metrics for all QR codes associated with a specific marketing campaign.

Request Parameters

idstringRequired
Unique campaign identifier.
Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/campaign/camp_9876" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": {
    "campaignId": "camp_9876",
    "name": "Q3 Billboards",
    "aggregatedScans": 28900,
    "topPerformingQr": { "id": "qr_sub_1", "scans": 9400 }
  }
}
GET

List Agency Clients

https://www.smllr.app/api/v1/external/reporting/clients

Returns all client organizations and sub-accounts managed under your agency or Enterprise umbrella.

Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/clients" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": [
    {
      "id": "client_555",
      "name": "Acme Corp",
      "activeQrs": 45,
      "status": "ACTIVE"
    }
  ]
}
GET

Specific Client Analytics

https://www.smllr.app/api/v1/external/reporting/client/:id

Retrieve comprehensive reporting data isolated to a single client organization account.

Request Parameters

idstringRequired
Client organization ID.
Request Example
curl -X GET "https://www.smllr.app/api/v1/external/reporting/client/client_555" \
  -H "x-api-key: smllr_live_your_api_key_here"
JSON Response (200 OK)
{
  "status": 200,
  "message": "Success",
  "data": {
    "clientId": "client_555",
    "clientName": "Acme Corp",
    "totalScans": 128500,
    "activeQrs": 45
  }
}

Ready to streamline your reporting?

Generate your Enterprise API key in your account settings and start querying your marketing analytics instantly.