Accessing leaderboard and user data

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 this article.

{
  "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 find out your Conversion Event's ID head over to this article.

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"]
}

Last updated