Pinterest CAPI events need seconds and event_id
conversions API Pinterest is Pinterest CAPI. The ad account ID lives in the path. The event payload is contracted as Pinterest documents it.
conversions API Pinterest
conversions API Pinterest is Pinterest CAPI. Seconds clock, event_id required, action_source web. Pinterest standard events stay lowercase on both pipes.
What this pack matches
Rules
Codes are stable. A finding in CI, MCP, or the playground lands on the same id.
| Field | Required | What it checks | Rule ids | Source |
|---|---|---|---|---|
ad_account_id |
required | It is the Pinterest ad account ID, and it travels in the path. Maximum decoded characters: 18. Fix: Put the ad account ID in the path as `/v5/ad_accounts/{ad_account_id}/events`. | vendor.pinterest-conversions-api.param.ad_account_id.missingvendor.pinterest-conversions-api.param.ad_account_id.emptyvendor.pinterest-conversions-api.param.ad_account_id.invalid |
docs |
test |
optional | The optional test query parameter selects test mode. | vendor.pinterest-conversions-api.param.test.emptyvendor.pinterest-conversions-api.param.test.invalid |
docs |
data |
required | The vendor documents the JSON shape or value type of this field. Native JSON type: array. Minimum array items: 1. Maximum array items: 1000. | vendor.pinterest-conversions-api.body.data.missingvendor.pinterest-conversions-api.body.data.invalid |
docs |
data[] |
optional | The vendor documents the JSON shape or value type of this field. Native JSON type: object. | vendor.pinterest-conversions-api.body.data[].invalid |
docs |
root |
optional | The published event or batch envelope is a JSON object. Native JSON type: object. | vendor.pinterest-conversions-api.body.root.invalid |
docs |
event_name |
required | It is the conversion event name. Standard names are documented, and a custom name may use letters, digits, underscores, and hyphens, up to 100 characters. The published custom example is TookSurvey. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. Fix: Send a documented name such as `checkout`, or a custom name mapped to a standard event in Ads Manager. | vendor.pinterest-conversions-api.body.event_name.missingvendor.pinterest-conversions-api.body.event_name.emptyvendor.pinterest-conversions-api.body.event_name.invalid |
docs |
action_source |
required | It is the platform the event was ingested from. Pinterest documents `web`, `app_android`, `app_ios`, and `offline`. Body scope: data[]. Native JSON type: string. Fix: Send `web`, `app_android`, `app_ios`, or `offline`. Pinterest spells `web` in lower case, unlike Snap. | vendor.pinterest-conversions-api.body.action_source.missingvendor.pinterest-conversions-api.body.action_source.emptyvendor.pinterest-conversions-api.body.action_source.invalid |
docs |
event_id |
required | It identifies the event for deduplication against the Pinterest tag. Body scope: data[]. Native JSON type: string. Fix: Send a stable id per conversion, such as an order number. | vendor.pinterest-conversions-api.body.event_id.missingvendor.pinterest-conversions-api.body.event_id.emptyvendor.pinterest-conversions-api.body.event_id.invalid |
docs |
event_time |
required | Pinterest documents a Unix timestamp in seconds. A 13-digit value is milliseconds. Body scope: data[]. Native JSON type: integer. Fix: Send seconds, not milliseconds: divide a JavaScript `Date.now()` by 1000 and floor it. | vendor.pinterest-conversions-api.body.event_time.missingvendor.pinterest-conversions-api.body.event_time.invalid |
docs |
user_data |
required | Pinterest requires a `user_data` object, and it must include at least one of `em`, `hashed_maids`, or an IP and user agent pair. Body scope: data[]. Native JSON type: object. Fix: Add `user_data` with a hashed email, hashed MAIDs, or `client_ip_address` and `client_user_agent`. | vendor.pinterest-conversions-api.body.user_data.missingvendor.pinterest-conversions-api.body.user_data.invalid |
docs |
user_data.em |
optional | Email must be lowercased and SHA-256 hashed before it is sent. Body scope: data[]. Native JSON type: string or array. Fix: Lowercase the address, hash it with SHA-256, and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.em.emptyvendor.pinterest-conversions-api.body.user_data.em.invalid |
docs |
user_data.em[] |
optional | Every email in the list must be lowercased and SHA-256 hashed. Body scope: data[]. Native JSON type: string. Fix: Hash each address with SHA-256 and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.em[].emptyvendor.pinterest-conversions-api.body.user_data.em[].invalid |
docs |
user_data.ph |
optional | Phone must be digits-only with country code, then SHA-256 hashed. Body scope: data[]. Native JSON type: string or array. Fix: Strip symbols, keep the country code, hash with SHA-256, and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.ph.emptyvendor.pinterest-conversions-api.body.user_data.ph.invalid |
docs |
user_data.external_id |
optional | External IDs must be SHA-256 hashed. Body scope: data[]. Native JSON type: string or array. Fix: Hash the customer id with SHA-256 and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.external_id.emptyvendor.pinterest-conversions-api.body.user_data.external_id.invalid |
docs |
user_data.client_ip_address |
optional | It is the visitor IP address, sent unhashed. Body scope: data[]. Native JSON type: string. Fix: Send the browser's public IP, not a digest. | vendor.pinterest-conversions-api.body.user_data.client_ip_address.emptyvendor.pinterest-conversions-api.body.user_data.client_ip_address.invalid |
docs |
user_data.client_user_agent |
optional | It is the visitor user agent, sent unhashed. Body scope: data[]. Native JSON type: string. Fix: Send the browser's user agent string, not a digest. | vendor.pinterest-conversions-api.body.user_data.client_user_agent.emptyvendor.pinterest-conversions-api.body.user_data.client_user_agent.invalid |
docs |
user_data.hashed_maids |
optional | Hashed GAID or IDFA. Pinterest documents SHA-256. Body scope: data[]. Native JSON type: string or array. Fix: Hash the MAID with SHA-256 and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.hashed_maids.emptyvendor.pinterest-conversions-api.body.user_data.hashed_maids.invalid |
docs |
user_data.hashed_maids[] |
optional | Every MAID in the list must be SHA-256 hashed. Body scope: data[]. Native JSON type: string. Fix: Hash each MAID with SHA-256 and send the hex digest. | vendor.pinterest-conversions-api.body.user_data.hashed_maids[].emptyvendor.pinterest-conversions-api.body.user_data.hashed_maids[].invalid |
docs |
custom_data.currency |
optional | It is an ISO 4217 currency code. Body scope: data[]. Native JSON type: string or null. Fix: Use the three-letter code, such as `USD`. | vendor.pinterest-conversions-api.body.custom_data.currency.emptyvendor.pinterest-conversions-api.body.custom_data.currency.invalid |
docs |
custom_data.value |
optional | It is the total monetary value of purchased items. Pinterest documents a string parsed as a double, with no negatives, and currency whenever it is sent. Body scope: data[]. Native JSON type: string or null. Fix: Send the pre-tax, pre-shipping total in `custom_data.value` as a number, such as `66.95`. | vendor.pinterest-conversions-api.body.custom_data.value.emptyvendor.pinterest-conversions-api.body.custom_data.value.invalid |
docs |
custom_data.content_ids |
optional | It is a product ID related to the event. Pinterest documents an array of IDs that also appear on `custom_data.contents`. Body scope: data[]. Native JSON type: array. Fix: Send catalog IDs in `custom_data.content_ids`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.content_ids.emptyvendor.pinterest-conversions-api.body.custom_data.content_ids.invalid |
docs |
custom_data.content_ids[] |
optional | Every listed ID is a product ID related to the event. Body scope: data[]. Native JSON type: string. Fix: Send catalog IDs in `custom_data.content_ids`, or drop empty entries. | vendor.pinterest-conversions-api.body.custom_data.content_ids[].emptyvendor.pinterest-conversions-api.body.custom_data.content_ids[].invalid |
docs |
custom_data.content_name |
optional | It is the name of the page or product associated with the event. Body scope: data[]. Native JSON type: string or null. Fix: Send the page or product name in `custom_data.content_name`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.content_name.emptyvendor.pinterest-conversions-api.body.custom_data.content_name.invalid |
docs |
custom_data.content_category |
optional | It is the type of merchandise. Pinterest documents `content_category` on the product event table. Body scope: data[]. Native JSON type: string or null. Fix: Send the merchandise type in `custom_data.content_category`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.content_category.emptyvendor.pinterest-conversions-api.body.custom_data.content_category.invalid |
docs |
custom_data.content_brand |
optional | It is the brand of merchandise. Pinterest documents `content_brand` on the product event table. Body scope: data[]. Native JSON type: string or null. Fix: Send the brand in `custom_data.content_brand`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.content_brand.emptyvendor.pinterest-conversions-api.body.custom_data.content_brand.invalid |
docs |
custom_data.num_items |
optional | It is the total number of products involved, for example items purchased in a checkout. Body scope: data[]. Native JSON type: integer. Fix: Send a whole number in `custom_data.num_items`, such as `2`. | vendor.pinterest-conversions-api.body.custom_data.num_items.emptyvendor.pinterest-conversions-api.body.custom_data.num_items.invalid |
docs |
custom_data.order_id |
optional | It identifies the order in a purchase-related event. Body scope: data[]. Native JSON type: string or null. Fix: Send the order id in `custom_data.order_id`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.order_id.emptyvendor.pinterest-conversions-api.body.custom_data.order_id.invalid |
docs |
custom_data.search_string |
optional | It is the string entered in a search event. Body scope: data[]. Native JSON type: string or null. Fix: Send the query in `custom_data.search_string`, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.search_string.emptyvendor.pinterest-conversions-api.body.custom_data.search_string.invalid |
docs |
custom_data.opt_out_type |
optional | It is the privacy opt-out type. Pinterest documents `ldp` as the only accepted value for limited data processing. Body scope: data[]. Native JSON type: string or null. Fix: Set `custom_data.opt_out_type` to `ldp`, or drop the pair. | vendor.pinterest-conversions-api.body.custom_data.opt_out_type.emptyvendor.pinterest-conversions-api.body.custom_data.opt_out_type.invalid |
docs |
custom_data.contents[].id |
optional | It is the product ID of an individual merchandise item. Body scope: data[]. Native JSON type: string. Fix: Set `custom_data.contents[].id` to the catalog item ID, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.contents[].id.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].id.invalid |
docs |
custom_data.contents[].item_name |
optional | It is the product name of an individual merchandise item. Body scope: data[]. Native JSON type: string. Fix: Set `custom_data.contents[].item_name` to the product name, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.contents[].item_name.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].item_name.invalid |
docs |
custom_data.contents[].item_category |
optional | It is the product category of an individual merchandise item. Body scope: data[]. Native JSON type: string. Fix: Set `custom_data.contents[].item_category` to the category, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.contents[].item_category.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].item_category.invalid |
docs |
custom_data.contents[].item_brand |
optional | It is the brand of an individual merchandise item. Body scope: data[]. Native JSON type: string. Fix: Set `custom_data.contents[].item_brand` to the brand, or drop the empty pair. | vendor.pinterest-conversions-api.body.custom_data.contents[].item_brand.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].item_brand.invalid |
docs |
custom_data.contents[].item_price |
optional | It is the price of one merchandise item (single quantity). Pinterest documents it as a string parsed as a number. Body scope: data[]. Native JSON type: string. Fix: Send `custom_data.contents[].item_price` as a number, such as `19.99`. Put the order total in `custom_data.value`. | vendor.pinterest-conversions-api.body.custom_data.contents[].item_price.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].item_price.invalid |
docs |
custom_data.contents[].quantity |
optional | It is the quantity of that merchandise item selected by the user. Body scope: data[]. Native JSON type: integer. Fix: Send a whole number in `custom_data.contents[].quantity`, such as `2`. | vendor.pinterest-conversions-api.body.custom_data.contents[].quantity.emptyvendor.pinterest-conversions-api.body.custom_data.contents[].quantity.invalid |
docs |
root |
optional | Each event is a JSON object, rather than a scalar or list. Body scope: data[]. Native JSON type: object. | vendor.pinterest-conversions-api.body.root.invalid |
docs |
custom_data |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: object. | vendor.pinterest-conversions-api.body.custom_data.invalid |
docs |
user_data.ph[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.ph[].emptyvendor.pinterest-conversions-api.body.user_data.ph[].invalid |
docs |
user_data.external_id[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.external_id[].emptyvendor.pinterest-conversions-api.body.user_data.external_id[].invalid |
docs |
user_data.ct |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.ct.emptyvendor.pinterest-conversions-api.body.user_data.ct.invalid |
docs |
user_data.ct[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.ct[].emptyvendor.pinterest-conversions-api.body.user_data.ct[].invalid |
docs |
user_data.country |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.country.emptyvendor.pinterest-conversions-api.body.user_data.country.invalid |
docs |
user_data.country[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.country[].emptyvendor.pinterest-conversions-api.body.user_data.country[].invalid |
docs |
user_data.db |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.db.emptyvendor.pinterest-conversions-api.body.user_data.db.invalid |
docs |
user_data.db[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.db[].emptyvendor.pinterest-conversions-api.body.user_data.db[].invalid |
docs |
user_data.fn |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.fn.emptyvendor.pinterest-conversions-api.body.user_data.fn.invalid |
docs |
user_data.fn[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.fn[].emptyvendor.pinterest-conversions-api.body.user_data.fn[].invalid |
docs |
user_data.ge |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.ge.emptyvendor.pinterest-conversions-api.body.user_data.ge.invalid |
docs |
user_data.ge[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.ge[].emptyvendor.pinterest-conversions-api.body.user_data.ge[].invalid |
docs |
user_data.ln |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.ln.emptyvendor.pinterest-conversions-api.body.user_data.ln.invalid |
docs |
user_data.ln[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.ln[].emptyvendor.pinterest-conversions-api.body.user_data.ln[].invalid |
docs |
user_data.st |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.st.emptyvendor.pinterest-conversions-api.body.user_data.st.invalid |
docs |
user_data.st[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.st[].emptyvendor.pinterest-conversions-api.body.user_data.st[].invalid |
docs |
user_data.zp |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or array. | vendor.pinterest-conversions-api.body.user_data.zp.emptyvendor.pinterest-conversions-api.body.user_data.zp.invalid |
docs |
user_data.zp[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.user_data.zp[].emptyvendor.pinterest-conversions-api.body.user_data.zp[].invalid |
docs |
custom_data.contents |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: array. | vendor.pinterest-conversions-api.body.custom_data.contents.invalid |
docs |
custom_data.contents[] |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: object. | vendor.pinterest-conversions-api.body.custom_data.contents[].invalid |
docs |
app_id |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.app_id.invalid |
docs |
app_name |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.app_name.invalid |
docs |
app_version |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.app_version.invalid |
docs |
device_brand |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.device_brand.invalid |
docs |
device_carrier |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.device_carrier.invalid |
docs |
device_model |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.device_model.invalid |
docs |
device_type |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.device_type.invalid |
docs |
os_version |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.os_version.invalid |
docs |
language |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.language.emptyvendor.pinterest-conversions-api.body.language.invalid |
docs |
wifi |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: boolean. | vendor.pinterest-conversions-api.body.wifi.invalid |
docs |
user_data.partner_id |
optional | The vendor documents the JSON shape or value type of this field. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.user_data.partner_id.invalid |
docs |
app_info |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: object. | vendor.pinterest-conversions-api.body.app_info.invalid |
docs |
app_info.app_id |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 200. | vendor.pinterest-conversions-api.body.app_info.app_id.invalid |
docs |
app_info.app_name |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 200. | vendor.pinterest-conversions-api.body.app_info.app_name.invalid |
docs |
app_info.app_package_name |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 200. | vendor.pinterest-conversions-api.body.app_info.app_package_name.invalid |
docs |
app_info.app_store |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.app_info.app_store.invalid |
docs |
app_info.app_version |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.app_info.app_version.invalid |
docs |
app_info.install_time |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. | vendor.pinterest-conversions-api.body.app_info.install_time.invalid |
docs |
app_info.user_agent |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 16384. | vendor.pinterest-conversions-api.body.app_info.user_agent.invalid |
docs |
app_info.window_height |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 30720. | vendor.pinterest-conversions-api.body.app_info.window_height.invalid |
docs |
app_info.window_width |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 30720. | vendor.pinterest-conversions-api.body.app_info.window_width.invalid |
docs |
custom_data.contents[].item_brand_id |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 64. | vendor.pinterest-conversions-api.body.custom_data.contents[].item_brand_id.invalid |
docs |
custom_data.external_measurement_id |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.custom_data.external_measurement_id.invalid |
docs |
custom_data.external_measurement_vendor_id |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer or null. | vendor.pinterest-conversions-api.body.custom_data.external_measurement_vendor_id.invalid |
docs |
custom_data.np |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.custom_data.np.invalid |
docs |
custom_data.predicted_ltv |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.custom_data.predicted_ltv.invalid |
docs |
device_info |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: object. | vendor.pinterest-conversions-api.body.device_info.invalid |
docs |
device_info.battery_level |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 100. | vendor.pinterest-conversions-api.body.device_info.battery_level.invalid |
docs |
device_info.brand |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.brand.invalid |
docs |
device_info.carrier |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.carrier.invalid |
docs |
device_info.cpu_cores |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 1152. | vendor.pinterest-conversions-api.body.device_info.cpu_cores.invalid |
docs |
device_info.external_storage_free_space |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 1048576. | vendor.pinterest-conversions-api.body.device_info.external_storage_free_space.invalid |
docs |
device_info.external_storage_size |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 1048576. | vendor.pinterest-conversions-api.body.device_info.external_storage_size.invalid |
docs |
device_info.form_factor |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.device_info.form_factor.emptyvendor.pinterest-conversions-api.body.device_info.form_factor.invalid |
docs |
device_info.kernel_version |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.kernel_version.invalid |
docs |
device_info.languages |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: array. Minimum array items: 0. Maximum array items: 100. | vendor.pinterest-conversions-api.body.device_info.languages.invalid |
docs |
device_info.languages[] |
optional | Each array item uses the native type declared by Pinterest OpenAPI. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.device_info.languages[].invalid |
docs |
device_info.locale |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 35. | vendor.pinterest-conversions-api.body.device_info.locale.invalid |
docs |
device_info.model |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.model.invalid |
docs |
device_info.network_type |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.device_info.network_type.emptyvendor.pinterest-conversions-api.body.device_info.network_type.invalid |
docs |
device_info.os_family |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. | vendor.pinterest-conversions-api.body.device_info.os_family.emptyvendor.pinterest-conversions-api.body.device_info.os_family.invalid |
docs |
device_info.os_name |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.os_name.invalid |
docs |
device_info.os_release_name |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.os_release_name.invalid |
docs |
device_info.os_version |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.os_version.invalid |
docs |
device_info.screen_density |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 100000. | vendor.pinterest-conversions-api.body.device_info.screen_density.invalid |
docs |
device_info.screen_height |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 30720. | vendor.pinterest-conversions-api.body.device_info.screen_height.invalid |
docs |
device_info.screen_width |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 30720. | vendor.pinterest-conversions-api.body.device_info.screen_width.invalid |
docs |
device_info.storage_free_space |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 1048576. | vendor.pinterest-conversions-api.body.device_info.storage_free_space.invalid |
docs |
device_info.storage_size |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: integer. Minimum numeric value: 0. Maximum numeric value: 1048576. | vendor.pinterest-conversions-api.body.device_info.storage_size.invalid |
docs |
device_info.timezone |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 40. | vendor.pinterest-conversions-api.body.device_info.timezone.invalid |
docs |
device_info.timezone_abbr |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 5. | vendor.pinterest-conversions-api.body.device_info.timezone_abbr.invalid |
docs |
device_info.type |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string. Maximum decoded characters: 100. | vendor.pinterest-conversions-api.body.device_info.type.invalid |
docs |
event_source_url |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.event_source_url.invalid |
docs |
opt_out |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: boolean. | vendor.pinterest-conversions-api.body.opt_out.invalid |
docs |
partner_name |
optional | Pinterest documents partner_name as direct for a direct integration, or ss- followed by the partner name. Body scope: data[]. Native JSON type: string or null. Fix: Send direct, or ss- plus the partner name, such as ss-acme. | vendor.pinterest-conversions-api.body.partner_name.invalid |
docs |
user_data.click_id |
optional | Pinterest OpenAPI declares this field in its conversion request model. Body scope: data[]. Native JSON type: string or null. | vendor.pinterest-conversions-api.body.user_data.click_id.invalid |
docs |
body.event_name.charset |
recommended | The event name uses a character other than letters, digits, underscores, or hyphens. Pinterest documents that alphabet for custom names, up to 100 characters. Body scope: data[]. Fix: Use letters, digits, underscores, or hyphens, such as TookSurvey or checkout. | vendor.pinterest-conversions-api.body.event_name.charset |
docs |
body.partner_name.shape |
recommended | partner_name is not direct and does not start with ss-. Pinterest documents direct for a direct integration, and ss- followed by the partner name otherwise. Body scope: data[]. Fix: Send direct, or ss- plus the partner name, such as ss-acme. | vendor.pinterest-conversions-api.body.partner_name.shape |
docs |
body.checkout_requires_value_and_currency |
recommended | A `checkout` event is missing `custom_data.value` or `custom_data.currency`. Pinterest documents both as recommended for checkout. Body scope: data[]. Fix: Send the checkout total and a three-letter currency code. | vendor.pinterest-conversions-api.body.checkout_requires_value_and_currency |
docs |
body.value_requires_currency |
recommended | The event carries `custom_data.value` with no `custom_data.currency`. Pinterest documents currency as required whenever value is sent. Body scope: data[]. Fix: Add `custom_data.currency` as a three-letter code alongside the value. | vendor.pinterest-conversions-api.body.value_requires_currency |
docs |
body.user_needs_an_identifier |
required | `user_data` carries none of the identifiers Pinterest requires. Send `em`, `hashed_maids`, or `client_ip_address` with `client_user_agent`. Body scope: data[]. Fix: Add a hashed email, hashed MAIDs, or the IP and user agent pair. | vendor.pinterest-conversions-api.body.user_needs_an_identifier |
docs |
body.unhashed_email |
required | A field carries what looks like a raw email address. Pinterest requires `user_data.em` to be a SHA-256 hex digest. Body scope: data[]. Fix: Lowercase the address, hash it with SHA-256, and send the hex digest. | vendor.pinterest-conversions-api.body.unhashed_email |
docs |
body.hashed_plaintext_field |
required | This field looks like a SHA-256 digest, but Pinterest documents `client_ip_address` and `client_user_agent` as unhashed. Body scope: data[]. Fix: Send the raw IP address or user agent. Hashing it makes the event unmatchable. | vendor.pinterest-conversions-api.body.hashed_plaintext_field |
docs |
body.zero_ip |
required | Pinterest forbids a pure zero IPv4 matching address. Body scope: data[]. | vendor.pinterest-conversions-api.body.zero_ip |
docs |
body.placeholder_user_agent |
required | Pinterest forbids placeholder user agent values Other and null. Body scope: data[]. | vendor.pinterest-conversions-api.body.placeholder_user_agent |
docs |
body.event_time_time_window |
required | Pinterest documents that event_time cannot be later than receipt of the request. Body scope: data[]. | vendor.pinterest-conversions-api.body.event_time_time_window |
docs |
method |
required | The cited primary model documents this field representation. Complete HTTP capture contract. Native JSON type: string. | vendor.pinterest-conversions-api.http.method.missingvendor.pinterest-conversions-api.http.method.emptyvendor.pinterest-conversions-api.http.method.invalid |
docs |
content_type |
required | The cited primary model documents this field representation. Complete HTTP capture contract. Native JSON type: string. | vendor.pinterest-conversions-api.http.content_type.missingvendor.pinterest-conversions-api.http.content_type.emptyvendor.pinterest-conversions-api.http.content_type.invalid |
docs |
headers.authorization |
required | The cited primary model documents this field representation. Complete HTTP capture contract. Native JSON type: string. | vendor.pinterest-conversions-api.http.headers.authorization.missingvendor.pinterest-conversions-api.http.headers.authorization.emptyvendor.pinterest-conversions-api.http.headers.authorization.invalid |
docs |
body |
required | The cited primary model documents this field representation. Complete HTTP capture contract. Native JSON type: object. | vendor.pinterest-conversions-api.http.body.missingvendor.pinterest-conversions-api.http.body.invalid |
docs |
Validate a payload
pixellint validate json @payload.json --rulepack vendor/pinterest-conversions-api
Try this failing payload in the playground. Pinterest CAPI missing event_id.
{"data":[{"event_name":"checkout","action_source":"web","event_time":1770000000,"event_source_url":"https://shop.example/thanks","user_data":{}}]}
cargo install pixellint
·
npm install pixellint