Verify Custom Conversion Events in the API

Not using a direct integration with the Conversions API? Try verifying with the Events Manager.

Get a report for a custom conversion event by requesting conversion_custom_event_{{index}}_{{field}} in fields for POST Get a report.

Reporting returns conversion data based on the attribution window selected in the Reddit Ads dashboard.

1. Find the index mapping

Call GET Last Fired At and use custom_events in the response to map custom event labels.

Example: GET Last Fired At response

{
  "data": {
    // Additional fields here
    "custom_events": [
      {
        "last_fired_at": "2024-03-12T00:58:29.862000+00:00",
        "name": "my_custom_conversion_event"
      },
      {
        "last_fired_at": "2024-03-11T19:03:32+00:00",
        "name": "begin_checkout"
      },
      {
        "last_fired_at": "2024-03-12T00:59:05.981000+00:00",
        "name": "login"
      },
      {
        "last_fired_at": "2024-03-11T08:03:41.323000+00:00",
        "name": "select_item"
      },
      {
        "last_fired_at": "2024-03-10T23:36:53.844000+00:00",
        "name": "share"
      }
    ]
  }
}

The custom conversion events will be listed by their index in ascending order, starting with 1. For example, the first conversion event will have an index of 1.

2. Get the report for a custom event

Fetch data for custom conversion events by calling POST Get a report and setting conversion_custom_event_{{index}}_{{field}} for the field, where:

Parameter	Requirements	Description
{{index}} (integer)	Between 1 and 20	The slot for the custom conversion event. For example, if your event was the first item in the custom_events array, you should set this to 1.
{{field}} (string)	Must include at least one of the following: avg_value clicks ecpa total_items total_value views	The field that you want to be returned in your metrics.

Example: Return click and view conversions for a custom conversion event (lines 4-5)

{
  "data": {
    "fields": [
      "conversion_custom_event_{{index}}_clicks",
 "conversion_custom_event_{{index}}_views"
    ],
    "starts_at": "2024-03-10T00:00:00Z",
    "ends_at": "2024-03-12T00:00:00Z"
  }
}

Data will be returned in the same format as standard conversion events.

Example: GET A Report response

{
    "data": {
        "metrics": [
            {
                "conversion_purchase_clicks": 7,
                "conversion_purchase_views": 0,
                "conversion_custom_event_1_clicks": 56,
                "conversion_custom_event_1_views": 0,
                "conversion_custom_event_3_clicks": 36,
                "conversion_custom_event_3_views": 0,
            }
        ],
        // Additional fields here
    },
    "pagination": {
        // Additional fields here
        }
}