Skip to main content
LoyaltyDog exposes merchant metrics and program lists you can pull into a BI tool. This guide covers the API surface.

​
What’s available

GET /v2/merchants/{merchant_id}/metrics takes period. Production documents 7d, 30d, 90d, and custom. The default is 30d. GET /v2/merchants/{merchant_id}/metrics/chart takes metric and period. Production documents member_growth, redemptions, points_issued, and engagement_rate. The default metric is member_growth. period uses the same values as the metrics route. Those two merchant routes are served by the API. They are not in the public API reference. Transactions, customers, and the gift card business report are in the API reference.

​
Common patterns

LOYALTYDOG_API_URL is https://api.loyalty.dog/v2. Append the route, such as /merchants/m_123/metrics.

​
Daily snapshot

Schedule a daily job that pulls metrics and pipes them into your BI tool:

​
Time-series for a custom dashboard

​
Best practices

  • Cache aggressively. Reports are eventually consistent — minute-level freshness is more than enough for most dashboards.
  • Page through large lists. Transactions and customers accept page, limit, and offset.
  • For real-time, prefer webhooks. Polling reports is the wrong tool when you need event-level reaction. See Webhooks.