Ad logs and effectiveness-measurement data

ReceiptRoller handles campaigns, coupons, ad-delivery logs, and contribution to purchases (attribution) in one place. A distinctive feature is that you can measure the return on investment (ROI) of marketing efforts by combining it with receipt data.

Main resources

Related scopes

• campaign.read / campaign.write
• coupon.read / coupon.write
• ad_log.read — read ad logs
• analytics.read — read aggregate reports

Main endpoints

GET  /v1/campaigns                       ← list campaigns
POST /v1/campaigns                       ← create new
GET  /v1/coupons                         ← list coupons
GET  /v1/coupon_redemptions              ← coupon usage records
GET  /v1/ad_logs?campaign_id=...         ← ad logs
GET  /v1/analytics/campaign/{id}         ← aggregation by campaign

Attribution

Purchases that occur within a certain window (default 30 days) after an ad click are automatically linked to the relevant campaign. The attribution_window can be changed per campaign.

GET /v1/analytics/campaign/cmp_xyz
→
{
  "campaign_id": "cmp_xyz",
  "impressions": 12500,
  "clicks": 850,
  "ctr": 0.068,
  "attributed_purchases": 47,
  "attributed_revenue": 158400,
  "roas": 2.64
}

Webhook events

• campaign.started / campaign.ended
• coupon.redeemed — coupon used
• ad.click — ad click (batch delivery, 5-minute granularity)

Coupon design examples

• Amount discount: discount_type: "amount", discount_value: 500
• Percentage discount: discount_type: "percent", discount_value: 10
• Product-specific: applicable_products: ["prd_a01", ...]
• Minimum purchase amount: min_purchase: 3000
• Once per person: per_user_limit: 1

Related guides

• Purchase and receipt data integration
• OAuth scopes reference
• Back to the developer help index