API referenceReports

Query Reports

Query company reports using a standardized query format. Supports booking analytics, demand, product/stock performance, and customer analytics with date, location, product, and category filters.

GET

/api/v1/reports/query

GET

/reports/query

curl -X GET "https://dash.lockii.app/api/v1/reports/query?report=booking_analytics" \
  -H "x-api-key: $LOCKII_API_KEY"

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Parameters

report
enum<string>
query
required
Report to query.
One of:
booking_analytics
performance
customer_analytics
demand
query
object
query
Pass as a JSON string.
Default:
{"limit":10}

Response

application/json

JSON result for this operation.

object

{}

API referenceReports

Query Reports

Query company reports using a standardized query format. Supports booking analytics, demand, product/stock performance, and customer analytics with date, location, product, and category filters.

GET

/api/v1/reports/query

GET

/reports/query

curl -X GET "https://dash.lockii.app/api/v1/reports/query?report=booking_analytics" \
  -H "x-api-key: $LOCKII_API_KEY"

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Parameters

report
enum<string>
query
required
Report to query.
One of:
booking_analytics
performance
customer_analytics
demand
query
object
query
Pass as a JSON string.
Default:
{"limit":10}

Response

application/json

JSON result for this operation.

object

{}