--- title: "conversions/track" method: POST path: "/v2/api/conversions/track" --- # conversions/track `POST /v2/api/conversions/track` ## Request body - object - `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. - `email` string — SHA256 Hash. Trim any leading and trailing spaces. Convert all characters to lowercase. - `phone_number` string — SHA256 Hash. Unhashed phone number format should consist of exactly ten digits, devoid of any special characters or international country codes. - `first_name` string — SHA256 Hash. Lowercase. - `last_name` string — SHA256 Hash. Lowercase - `date_of_birth` string — SHA256 Hash. YYYYMMDD Format - `street_address` string — SHA256 Hash - `city` string — SHA256 Hash. Lowercase with no special characters or spaces. - `state` string — SHA256 Hash. Lowercase two letter ANSI abbreviation code. - `zip_code` string — SHA256 Hash. First 5 digits for U.S. zip codes - `country` string — SHA256 Hash. lowercase, 2-letter country codes in ISO 3166-1 alpha-2. - `pixel_id` string — This will allow us to dedup events for an advertiser that sends events via both the CAPI and the pixel. Making it soft required for multiple pixel implementation. - `click_id` string — The `ndclid` parameter, a Nextdoor-specific parameter, is automatically added to click-through URLs. - `client_ip_address` string — Must be a valid IPV4 or IPV6 address. Do not hash. The IP address of the browser corresponding to the event. - `data_source_id` string — Also known as the pixel ID. This will allow us to dedup events for an advertiser that sends events via both the CAPI and the pixel. Making it soft required for multiple pixel implementation. - `gender` string — Initial in lowercase: f for female, m for male, n for non-binary; or leave this empty if prefer not to say. Must be hashed. - `external_id` string — Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. You can send one or more external IDs for a given event. If an External ID is being sent via other channels, it should be in the same format as when sent via the Conversions API. - `client_user_agent` string — Do not hash. The client_user_agent is required for website events shared using the CAPI. - `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, }] - `order_value` string — Required for purchase events. ISO 4217 currency followed by the total numeric value(upto two decimal places) associated with event. Examples: * USD123 * USD123.12 * EUR432 - `order_id` string — The order ID for this transaction. Required for offline events. - `delivery_category` string — Supported values above. - `product_context` object - `app` object — Required for App events. - `app_id` string — it corresponds to a unique ID for advertisers mobile app ID from App store and Google Play Store. - `app_tracking_enabled` boolean — Users opt out settings for ATT - `platform` string — iOS / Android - `app_version` string — Mobile app version - `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. ## Response `200` 200 ## Other responses - `400` — 400 --- [API](https://skmtc.net/nextdoor/apis/share-api.md) · [All operations](https://skmtc.net/nextdoor/apis/share-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextdoor/share-api/versions/e267916612d6/schema)