conversions/track

post

https://ads.nextdoor.com/v2/api/conversions/track

The conversions/track API reference page explains how developers can report and track conversion events to Nextdoor via the Nextdoor CAPI, detailing required parameters and example event data formats.

Body Params

event_name

string

required

Conversion event name. Supported values above.

event_id

string

required

Any string or hashed ID that can identify a unique event. This is required to deduplicate events from CAPI and pixel tracking. It should be any deterministic ID that can be used for conversion api and pixel tracking.

event_time

string

Timestamp that the event took place. Timestamp with ISO 8601 format. For example, 2022-11-23T03:30:52Z. Time here is in UTC. Require one of the event_time or event_time_epoch.

event_timezone

string

Optional timezone indicating where the conversion event took place.

action_source

string

required

Indicates the channel through which conversion happened. Supported values above.

client_id

string

NAM Advertiser ID (aka ad account id) *ask Nextdoor account team if you don't have it.

action_source_url

string

The action_source_url is required for website events. The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain.

delivery_optimization

boolean

True indicates data can be used for optimization. False indicates the data will only be used for attribution

test_event

string

Flag to indicate if this is a test event. If its not present we’ll default to False.

partner_id

string

Free text field to enter the name of integration vendor (tealium, gtm, or zapier) or agency partner. Used for reference, tracking and troubleshooting; not intended for attribution purposes.

customer

object

required

Contains information about customer. We’ll use multiple signals present in this field to match against nextdoor users.

custom

object

A list of JSON objects that contain the product IDs associated with the event plus information about the products. Available fields: id, content_name, quantity, item_price Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99, }]

app

object

Required for App events.

event_time_epoch

integer

required

For backward compatibility, require one of the event_time or event_time_epoch. Number of seconds since 1970-01-01. No millis.

data_source_id

string

required

Also known as the pixel_ID; used to dedupe events from CAPI and pixel. It's softly required for multiple pixel implementations.

restricted_data_usage

integer

Default is null. If an advertiser explicitly passes true or 1, Nextdoor will only use the event for reporting purposes.

restricted_data_usage_country

integer

Associates a country with this data processing option. Default is null. The currently accepted value is 1 for the United States of America.

restricted_data_usage_state

integer

Associates a state with this data processing option. Default is null. See above for accepted values.

Responses

200200

400400