Cookie3 Docs
  • πŸ‘‹Introduction
  • πŸ‘‰Register your account
  • πŸ”ŒSetup your site or app
    • 1️⃣Add your website or app
    • 2️⃣Install Cookie3 snippet in your website or app
    • 3️⃣Installation guide
      • ⚑Integration with Google Tag Manager (GTM)
    • 4️⃣Verifying installation status
    • 5️⃣Security measures
    • 6️⃣Setup in-app custom events
    • 7️⃣Setting up consent management
    • How to retrieve your siteID?
    • ↗️Upgrading the snippet version
      • Troubleshooting
  • πŸ‘©β€πŸ’ΌAdd your team members
  • πŸͺFeatures
    • πŸ“ˆOnchain Explorer
      • Filters
      • Supported blockchains
      • Charts & metrics
      • Data export
      • CSV import
      • Audiences
    • πŸ•ΈοΈWeb Analytics
      • Selecting a website or app
      • Filters
      • Onchain reporting
      • Acquisition report
        • πŸ”ŽData dimensions
        • πŸ“ˆKey metrics
      • Conversions report
        • πŸ“ˆKey metrics
        • πŸ’²Show attribution report per conversion event
    • πŸ’²Conversion Events
      • How our attribution works?
      • Onchain conversion events
        • Attributed USD Value
      • Offchain conversion events
      • Retrieving your Conversion Event unique ID
    • 🐦KOL Intelligence
      • Getting started
        • Organic KOLs and Lists
        • KOL Dashboard
        • Searchbar
        • KOL Activity Chart
          • Extending the chart with additional Metrics
        • Advanced Metrics
        • Performance Table
          • KOL metrics explained
        • Post Feed
      • Your KOLs
        • Importing KOL Lists
          • Understanding the loading status during KOL upload
        • Managing KOLs in a given project
        • KOL List summary
      • AI-powered KOL scoring system
      • Campaigns
    • πŸ“ŠToken Analytics
  • βš™οΈAPI
    • πŸŒ€Referral Systems
      • Setup referral tracking
      • Accessing leaderboard and user data
      • API Response schema
      • Best practices
      • FAQ
Powered by GitBook
On this page
  • Parameters Explained
  • Retrieving Data for a Particular User

Was this helpful?

  1. API
  2. Referral Systems

Accessing leaderboard and user data

PreviousSetup referral trackingNextAPI Response schema

Last updated 8 months ago

Was this helpful?

To retrieve the Leaderboard metrics, make a POST request to:

https://wa.api.gateway.cookie3.co/acquisition/getGroupedMetrics

Sample Request Body

To find out your Conversion Event's ID head over to .

{
  "filter": {
    "dateFrom": "2024-10-01T00:00:00.000Z",
    "dateTo": "2024-10-31T23:59:59.999Z",
    "sites": ["<YOUR_SITE_ID>"]
  },
  "primaryGroupingDimension": "CustomReferrer",
  "goalIds": ["yourConversionEventId"]
}

Parameters Explained

  • Filter:

    • dateFrom and dateTo: Specify the time frame in ISO datetime format

    • sites: An array of siteIds

  • Primary grouping dimension: Groups data by primary dimension (e.g., CustomReferrer)

  • goalIds: An array of your Conversion Event IDs

Retrieving Data for a Particular User

To retrieve data for a specific user, add the customFilters object to your request body:

{
  "filter": {
    "dateFrom": "2024-10-01T00:00:00.000Z",
    "dateTo": "2024-10-31T23:59:59.999Z",
    "sites": ["<YOUR_SITE_ID>"]
  },
  "customFilters": {
    "equalFilterCustomReferrer": [
      "cookie-monster"
    ]
  },
  "primaryGroupingDimension": "CustomReferrer",
  "goalIds": ["yourConversionEventId"]
}

To find out your Conversion Event's ID head over to .

βš™οΈ
πŸŒ€
this article
this article