Analytics

Server

Download schema

Enterprise real-time analytics with BigQuery

POST

https://common-api.karma.life

/api/v1/analytics/batch

Execute multiple analytics queries in parallel

Request Body

object[] · required

Responses

Default Response

status

string · enum

Enum values:

success

object

POST/api/v1/analytics/batch

curl --request POST \
  --url https://common-api.karma.life/api/v1/analytics/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "queries": [
    {
      "queryType": "sales_hourly",
      "locationId": 0,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "granularity": "hour",
      "includeChildren": true,
      "filters": {}
    }
  ]
}
'

Example Request Body

{
  "queries": [
    {
      "queryType": "sales_hourly",
      "locationId": 0,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "granularity": "hour",
      "includeChildren": true,
      "filters": {}
    }
  ]
}

json

Example Responses

No example specified for this content type

application/json

GET

https://common-api.karma.life

/api/v1/analytics/channels

Get channel behavior metrics (POS, App, Kiosk, Delivery, QR)

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object[]

object

GET

https://common-api.karma.life

/api/v1/analytics/dashboard

Get comprehensive dashboard metrics in a single call. Returns sales inc/ex VAT, orders, products, tips, refunds, discounts, AOV, VAT breakdown, time series, top products, top categories, and channel breakdown.

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

granularity

string · enum

Time series granularity

Enum values:

hour

day

week

Default: hour

productSearch

string

Search filter for product titles

productLimit

number

Max products to return (default 10, max 500)

Default: 10

tableGroupIds

string

Comma-separated list of table group IDs (storefront_qr_code_groups.id) to restrict results to. When set, excludes orders without a QR code (e.g. pickup, delivery).

costCenterIds

string

Comma-separated list of cost center IDs (cost_centers.id) to restrict results to. Matches on COALESCE(tabs.cost_center_id, storefront_qr_codes.cost_center_id) — tab override beats table default. Orders without a cost center are excluded when this filter is active.

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/datastream-latency

Get DataStream latency metrics

query Parameters

locationId

number · required

Location ID

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/drilldown

Get drill-down analytics (Location → Hour → Item)

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

hour

number · min: 0 · max: 23

Hour of day (0-23)

itemId

number

Item ID for detailed orders

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/locations

Get location performance with hierarchy

query Parameters

locationId

number · required

Parent location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object[]

object

GET

https://common-api.karma.life

/api/v1/analytics/overview

Get overview dashboard with summary and charts

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/sales

Get sales metrics with hourly breakdown

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

granularity

string · enum

Time granularity

Enum values:

hour

day

week

Default: hour

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/tips-by-staff

Get tips totals per staff for the period. Tips are split proportionally across staff based on each staff member's share of committed-item revenue on the same tab. Unattributed share (no staff on tab) is returned with retailUserId = null.

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

tableGroupIds

string

Comma-separated list of table group IDs to restrict to.

Responses

Default Response

status

string · enum

Enum values:

success

object

Alerts Bookings

Karma Common API

Analytics

Server

Download schema

Enterprise real-time analytics with BigQuery

POST

https://common-api.karma.life

/api/v1/analytics/batch

Execute multiple analytics queries in parallel

Request Body

object[] · required

Responses

Default Response

status

string · enum

Enum values:

success

object

POST/api/v1/analytics/batch

curl --request POST \
  --url https://common-api.karma.life/api/v1/analytics/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "queries": [
    {
      "queryType": "sales_hourly",
      "locationId": 0,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "granularity": "hour",
      "includeChildren": true,
      "filters": {}
    }
  ]
}
'

Example Request Body

{
  "queries": [
    {
      "queryType": "sales_hourly",
      "locationId": 0,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "granularity": "hour",
      "includeChildren": true,
      "filters": {}
    }
  ]
}

json

Example Responses

No example specified for this content type

application/json

GET

https://common-api.karma.life

/api/v1/analytics/channels

Get channel behavior metrics (POS, App, Kiosk, Delivery, QR)

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object[]

object

GET

https://common-api.karma.life

/api/v1/analytics/dashboard

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

granularity

string · enum

Time series granularity

Enum values:

hour

day

week

Default: hour

productSearch

string

Search filter for product titles

productLimit

number

Max products to return (default 10, max 500)

Default: 10

tableGroupIds

string

Comma-separated list of table group IDs (storefront_qr_code_groups.id) to restrict results to. When set, excludes orders without a QR code (e.g. pickup, delivery).

costCenterIds

string

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/datastream-latency

Get DataStream latency metrics

query Parameters

locationId

number · required

Location ID

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/drilldown

Get drill-down analytics (Location → Hour → Item)

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

hour

number · min: 0 · max: 23

Hour of day (0-23)

itemId

number

Item ID for detailed orders

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/locations

Get location performance with hierarchy

query Parameters

locationId

number · required

Parent location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object[]

object

GET

https://common-api.karma.life

/api/v1/analytics/overview

Get overview dashboard with summary and charts

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/sales

Get sales metrics with hourly breakdown

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

granularity

string · enum

Time granularity

Enum values:

hour

day

week

Default: hour

Responses

Default Response

status

string · enum

Enum values:

success

object

GET

https://common-api.karma.life

/api/v1/analytics/tips-by-staff

query Parameters

locationId

number · required

Location ID

startDate

string · date-time

Start date (ISO 8601)

endDate

string · date-time

End date (ISO 8601)

includeChildren

boolean

Include child locations

Default: false

tableGroupIds

string

Comma-separated list of table group IDs to restrict to.

Responses

Default Response

status

string · enum

Enum values:

success

object

Alerts Bookings