API Reference
WS metric/transactions/conversion-rate

Conversion rate

Transactions per location entrant — retail POS conversion against footfall.

Returns transactions divided by location entrants per period. The headline retail conversion metric — answers “what fraction of visitors completed a purchase?”

Demographic-free. Point-of-sale records don’t carry visitor demographics. Use breakdownByDimensions: ["entity"].

Body parameters

FieldTypeRequiredDescription
startstring (ISO 8601)yesInclusive start timestamp with timezone
endstring (ISO 8601)yesInclusive end timestamp with timezone
entitiesstring[]yesArray of location, organisation, or recording IDs (matching entityType)
entityType"location" | "organisation"yesAggregation level
facetsstring[]yesWhat to include: segments, summary, aggregates
aggregationPeriodstringyesTime granularity — see aggregation period options
breakdownByDimensionsstring[]yesMust be ["entity"]
insideRecordingTimesbooleannotrue to restrict to opening hours only. Default false

Example request

{
  "action": "metric",
  "data": {
    "id": "req-cr-001",
    "route": "transactions/conversion-rate",
    "body": {
      "start": "2024-04-01T00:00:00.000Z",
      "end": "2024-04-07T23:59:59.000Z",
      "entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
      "entityType": "location",
      "breakdownByDimensions": ["entity"],
      "facets": ["segments", "summary"],
      "aggregationPeriod": "day"
    }
  }
}

Example response

req-cr-001|0|0|{
  "segments": [
    { "index": "2024-04-01T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_conversion_rate": 14.3 },
    { "index": "2024-04-02T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_conversion_rate": 13.1 }
  ],
  "summary": [
    { "location": "64a1b2c3d4e5f6a7b8c9d0e3", "sales_conversion_rate": 13.9 }
  ],
  "meta": {
    "units": {
      "sales_conversion_rate": "percentage"
    }
  }
}

null means the rate is undefined (no entries in the period). Don’t coerce null to 0.

Update frequency

Transactions update approximately every 30 minutes.