Singular EVENT is form fields, not JSON
v1 and v2 /evt take query or form parameters. p is a documented platform string, case-sensitive. n is 1 to 32 ASCII characters. Exactly one of ip or use_ip.
Platform spelling is case-sensitive
Singular documents iOS, Android, Web, and the rest with that capitalization. ios is not iOS. The call can still return 200.
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 |
|---|---|---|---|---|
a |
required | It is the Singular SDK Key, not the Reporting API Key, and every EVENT request requires it. Fix: Send the SDK Key as `a`. | vendor.singular.param.a.missingvendor.singular.param.a.empty |
docs |
p |
required | It is the platform, case-sensitive. Singular documents the values Android, iOS, Web, PC, Xbox, Playstation, Nintendo, MetaQuest, and CTV. Fix: Set `p` to the documented platform spelling, such as `iOS`. | vendor.singular.param.p.missingvendor.singular.param.p.emptyvendor.singular.param.p.invalid |
docs |
i |
required | It is the app identifier, case-sensitive, and every EVENT request requires it. Fix: Send the app ID as `i`. | vendor.singular.param.i.missingvendor.singular.param.i.empty |
docs |
n |
required | The event name has at most 32 UTF-8 bytes, including non-ASCII names. Maximum decoded UTF-8 bytes: 32. Fix: Use an event name of at most 32 UTF-8 bytes. | vendor.singular.param.n.missingvendor.singular.param.n.emptyvendor.singular.param.n.invalid |
docs |
ip |
optional | It is the public device IP. Singular requires `ip` or `use_ip`, and they are mutually exclusive. Fix: Send the device IPv4 as `ip`, or send `use_ip` instead. | vendor.singular.param.ip.emptyvendor.singular.param.ip.invalid |
docs |
use_ip |
optional | It tells Singular to use the request IP. Mutually exclusive with `ip`. | vendor.singular.param.use_ip.emptyvendor.singular.param.use_ip.invalid |
docs |
sdid |
optional | It is the Singular device ID, a UUIDv4. V2 requires it. New accounts as of 15 July 2026 must use V2. Fix: On `/api/v2/evt`, send `sdid` as a UUIDv4. | vendor.singular.param.sdid.emptyvendor.singular.param.sdid.invalid |
docs |
cur |
optional | It is an ISO 4217 currency code, uppercase, used with `amt` on revenue events. Fix: Send `cur` as `USD` together with `amt`. | vendor.singular.param.cur.emptyvendor.singular.param.cur.invalid |
docs |
amt |
optional | It is the revenue amount. Singular documents a number used with `cur`. Sending it makes the call a revenue event. Fix: Send `amt` as a number such as `2.51`, together with `cur`. | vendor.singular.param.amt.emptyvendor.singular.param.amt.invalid |
docs |
idfa |
optional | It is the iOS Identifier for Advertisers. Singular documents a UUIDv4 on EVENT V1. Omit it when unavailable. An empty string is rejected. Presence diagnostic severity: error. Fix: Send `idfa` as a UUID, or omit the pair. Do not send an empty value. | vendor.singular.param.idfa.emptyvendor.singular.param.idfa.invalid |
docs |
idfv |
optional | It is the iOS Identifier for Vendor. Singular documents a UUIDv4, required on iOS V1 regardless of ATT. Fix: Send `idfv` as a UUID on iOS V1. | vendor.singular.param.idfv.emptyvendor.singular.param.idfv.invalid |
docs |
aifa |
optional | It is the Google advertising ID. Singular documents a UUIDv4 on Google Play V1. Omit it when unavailable. An empty string is rejected. Presence diagnostic severity: error. Fix: Send `aifa` as a UUID, or omit the pair. Do not send an empty value. | vendor.singular.param.aifa.emptyvendor.singular.param.aifa.invalid |
docs |
asid |
optional | It is the Android App Set ID. Singular documents a UUIDv4 on Google Play V1. Fix: Send `asid` as a UUID on Google Play V1. | vendor.singular.param.asid.emptyvendor.singular.param.asid.invalid |
docs |
amid |
optional | It is the Amazon advertising ID. Singular documents a UUIDv4 for Fire devices. Fix: Send `amid` as a UUID on Amazon devices, or omit the pair. | vendor.singular.param.amid.emptyvendor.singular.param.amid.invalid |
docs |
oaid |
optional | It is the Open Advertising Identifier on Chinese OEM Android. Singular documents a UUID, but the published example is not a valid UUID, so only emptiness is checked. Fix: Send `oaid` when the device has no Google Play, or omit the pair. | vendor.singular.param.oaid.empty |
docs |
andi |
optional | It is the Android ID, a 64-bit value. Singular's example is 16 hex characters. It is allowed only when no other identifier is available and the app is not on Google Play. Value diagnostic severity: warning. Fix: Send `andi` only off Google Play when AIFA and ASID are unavailable. | vendor.singular.param.andi.emptyvendor.singular.param.andi.invalid |
docs |
ve |
optional | It is the OS version at event time. Singular documents it on EVENT requests. Fix: Send `ve` as the OS version, such as `9.2`. | vendor.singular.param.ve.empty |
docs |
ua |
optional | It is the device user agent. Singular documents it URL-encoded and unhashed. Fix: Send the raw user agent as `ua`. | vendor.singular.param.ua.empty |
docs |
lc |
optional | It is the IETF locale as `ll_CC`. Singular documents the plain form, with no Unicode extensions. Fix: Send `lc` as `en_US`. | vendor.singular.param.lc.emptyvendor.singular.param.lc.invalid |
docs |
country |
optional | It is an ISO 3166-1 alpha-2 country code. Singular documents it when `use_ip=true` or no IP is available. Fix: Send a two-letter code such as `US`. | vendor.singular.param.country.emptyvendor.singular.param.country.invalid |
docs |
c |
optional | It is the network connection type. Singular documents `wifi` or `carrier`. Fix: Send `c` as `wifi` or `carrier`. | vendor.singular.param.c.emptyvendor.singular.param.c.invalid |
docs |
att_authorization_status |
optional | It is the iOS ATT status. Singular documents 0 undetermined, 1 restricted, 2 denied, 3 authorized. Fix: Send `0`, `1`, `2`, or `3`. Pass `0` when ATT is not implemented. | vendor.singular.param.att_authorization_status.emptyvendor.singular.param.att_authorization_status.invalid |
docs |
utime |
optional | It is the event time as a 10-digit Unix timestamp. Fix: Send `utime` as 10-digit Unix seconds, such as `1483228800`. | vendor.singular.param.utime.emptyvendor.singular.param.utime.invalid |
docs |
umilisec |
optional | It is the event time as a 13-digit Unix timestamp in milliseconds. Fix: Send `umilisec` as 13-digit Unix milliseconds, such as `1483228800000`. | vendor.singular.param.umilisec.emptyvendor.singular.param.umilisec.invalid |
docs |
is_revenue_event |
optional | It marks a revenue event. Singular still treats the event as revenue when `amt` is present. Fix: Send `true` or `false`. Omit `amt` if the event is not revenue. | vendor.singular.param.is_revenue_event.emptyvendor.singular.param.is_revenue_event.invalid |
docs |
ma |
optional | It is the device make. Singular documents it together with `mo`. Fix: Send `ma` and `mo` together, such as `Apple` and `iPhone 4S`. | vendor.singular.param.ma.empty |
docs |
mo |
optional | It is the device model. Singular documents it together with `ma`. Fix: Send `ma` and `mo` together. | vendor.singular.param.mo.empty |
docs |
e |
optional | It is a JSON object of custom event attributes, URL-encoded. Singular documents a JSON object. Fix: Send a JSON object such as `{"sng_attr_content_id":5581}`, URL-encoded. | docs | |
bd |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.bd.empty |
docs |
app_v |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.app_v.empty |
docs |
cn |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.cn.empty |
docs |
custom_user_id |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.custom_user_id.empty |
docs |
purchase_receipt |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.purchase_receipt.empty |
docs |
receipt_signature |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.receipt_signature.empty |
docs |
purchase_product_id |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.purchase_product_id.empty |
docs |
purchase_transaction_id |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.purchase_transaction_id.empty |
docs |
dnt |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.dnt.emptyvendor.singular.param.dnt.invalid |
docs |
dntoff |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.dntoff.emptyvendor.singular.param.dntoff.invalid |
docs |
is_admon_revenue |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.is_admon_revenue.emptyvendor.singular.param.is_admon_revenue.invalid |
docs |
skan_conversion_value |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.skan_conversion_value.emptyvendor.singular.param.skan_conversion_value.invalid |
docs |
skan_first_call_timestamp |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.skan_first_call_timestamp.emptyvendor.singular.param.skan_first_call_timestamp.invalid |
docs |
skan_last_call_timestamp |
optional | The vendor documents the JSON shape or value type of this field. | vendor.singular.param.skan_last_call_timestamp.emptyvendor.singular.param.skan_last_call_timestamp.invalid |
docs |
data_sharing_options |
optional | The vendor documents the JSON shape or value type of this field. | docs | |
global_properties |
optional | A JSON-encoded object of global event properties, at most five pairs with 200-character keys and values. | docs | |
api_version |
optional | The EVENT endpoint version is captured from the URL path and controls its required device identity. | vendor.singular.param.api_version.emptyvendor.singular.param.api_version.invalid |
docs |
ip_required |
required | The request has neither `ip` nor `use_ip`. Singular requires one of them on every EVENT. Fix: Send the device IP as `ip`, or send `use_ip` to use the request address. | vendor.singular.ip_required |
docs |
ip_ambiguous |
required | The request sends both `ip` and `use_ip`. Singular documents them as mutually exclusive. Fix: Send only `ip` or only `use_ip`. | vendor.singular.ip_ambiguous |
docs |
hashed_plaintext_field |
required | This field looks like a SHA-256 digest, but Singular documents `ip` and `ua` as unhashed device values. Fix: Send the raw IP address or user agent. | vendor.singular.hashed_plaintext_field |
docs |
device_id_required |
required | EVENT V1 requires a platform identifier. SDID is the identifier for EVENT V2. Fix: On `/api/v2/evt` send `sdid`. On `/api/v1/evt` send a platform advertising ID. | vendor.singular.device_id_required |
docs |
amt_requires_currency |
required | The event sends `amt` without `cur`. Singular documents the ISO 4217 code together with the amount. Fix: Add `cur` as a three-letter uppercase code such as `USD`. | vendor.singular.amt_requires_currency |
docs |
make_requires_model |
required | The request sends `ma` without `mo`. Singular documents make and model together. Fix: Send `mo` with `ma`. | vendor.singular.make_requires_model |
docs |
model_requires_make |
required | The request sends `mo` without `ma`. Singular documents make and model together. Fix: Send `ma` with `mo`. | vendor.singular.model_requires_make |
docs |
use_ip_requires_country |
required | `use_ip=true` is missing `country`. Singular documents a two-letter country code when it cannot geolocate from `ip`. Fix: Send `country` as a two-letter code such as `US`. | vendor.singular.use_ip_requires_country |
docs |
ios_requires_idfv |
required | EVENT V1 on iOS always requires IDFV, independently of ATT and IDFA availability. | vendor.singular.ios_requires_idfv |
docs |
ad_revenue_requires_attributes |
required | Ad monetization events require both revenue flags, amount, currency, and mediation attributes. | vendor.singular.ad_revenue_requires_attributes |
docs |
ad_revenue_is_admon_revenue |
required | The ad monetization event requires its revenue flag to be true. | vendor.singular.ad_revenue_is_admon_revenue |
docs |
ad_revenue_is_revenue_event |
required | The ad monetization event requires its revenue flag to be true. | vendor.singular.ad_revenue_is_revenue_event |
docs |
v2_requires_sdid |
required | EVENT V2 requires the Singular device identifier, sdid. Platform advertising IDs do not replace it. | vendor.singular.v2_requires_sdid |
docs |
ios_requires_att |
required | The iOS EVENT contract always requires ATT status. Use 0 when ATT is not implemented. | vendor.singular.ios_requires_att |
docs |
google_play_requires_asid |
required | A Google Play EVENT V1 includes Android App Set ID regardless of GAID availability. | vendor.singular.google_play_requires_asid |
docs |
android_id_is_fallback |
required | Android ID is permitted only when other identifiers are unavailable and the app is outside Google Play. | vendor.singular.android_id_is_fallback |
docs |
root |
optional | The EVENT reference documents this JSON field or limit. Decoded body source: e. Encoding: json. Native JSON type: object. | vendor.singular.body.root.invalid |
docs |
* |
optional | The EVENT reference documents this JSON field or limit. Decoded body source: e. Encoding: json. Native JSON type: string or number or integer or boolean or object or array or null. Maximum decoded characters: 500. | vendor.singular.body.*.invalid |
docs |
attribute_keys_too_long… |
forbidden | The EVENT reference documents this JSON field or limit. Decoded body source: e. Encoding: json. | vendor.singular.body.attribute_keys_too_long.forbidden |
docs |
ehash |
optional | This case-sensitive standard event attribute contains a SHA-256 digest. Decoded body source: e. Encoding: json. Native JSON type: string. | vendor.singular.body.ehash.emptyvendor.singular.body.ehash.invalid |
docs |
phash |
optional | This case-sensitive standard event attribute contains a SHA-256 digest. Decoded body source: e. Encoding: json. Native JSON type: string. | vendor.singular.body.phash.emptyvendor.singular.body.phash.invalid |
docs |
fnamehash |
optional | This case-sensitive standard event attribute contains a SHA-256 digest. Decoded body source: e. Encoding: json. Native JSON type: string. | vendor.singular.body.fnamehash.emptyvendor.singular.body.fnamehash.invalid |
docs |
lnamehash |
optional | This case-sensitive standard event attribute contains a SHA-256 digest. Decoded body source: e. Encoding: json. Native JSON type: string. | vendor.singular.body.lnamehash.emptyvendor.singular.body.lnamehash.invalid |
docs |
phashE164 |
optional | This case-sensitive standard event attribute contains a SHA-256 digest. Decoded body source: e. Encoding: json. Native JSON type: string. | vendor.singular.body.phashE164.emptyvendor.singular.body.phashE164.invalid |
docs |
root |
optional | The EVENT reference documents this JSON field or limit. Decoded body source: global_properties. Encoding: json. Native JSON type: object. Maximum object properties: 5. | vendor.singular.body.root.invalid |
docs |
* |
optional | The EVENT reference documents this JSON field or limit. Decoded body source: global_properties. Encoding: json. Native JSON type: string or number or integer or boolean or object or array or null. Maximum decoded characters: 200. | vendor.singular.body.*.invalid |
docs |
property_keys_too_long… |
forbidden | The EVENT reference documents this JSON field or limit. Decoded body source: global_properties. Encoding: json. | vendor.singular.body.property_keys_too_long.forbidden |
docs |
root |
optional | The EVENT reference documents this JSON field or limit. Decoded body source: data_sharing_options. Encoding: json. Native JSON type: object. | vendor.singular.body.root.invalid |
docs |
limit_data_sharing |
required | The EVENT reference documents this JSON field or limit. Decoded body source: data_sharing_options. Encoding: json. Native JSON type: boolean. | vendor.singular.body.limit_data_sharing.missingvendor.singular.body.limit_data_sharing.invalid |
docs |
ad_platform |
required | Ad monetization revenue events require the ad network name in decoded e.ad_platform. Decoded body source: e. Encoding: json. Applies when {"kind":"value_in","param":"n","values":["__ADMON_USER_LEVEL_REVENUE__"]}. Native JSON type: string. | vendor.singular.body.ad_platform.missingvendor.singular.body.ad_platform.emptyvendor.singular.body.ad_platform.invalid |
docs |
method |
required | EVENT parameters travel on GET or POST. Complete HTTP capture contract. Native JSON type: string. | vendor.singular.http.method.missingvendor.singular.http.method.emptyvendor.singular.http.method.invalid |
docs |
path |
required | Use the v1 or v2 EVENT route. Complete HTTP capture contract. Native JSON type: string. | vendor.singular.http.path.missingvendor.singular.http.path.emptyvendor.singular.http.path.invalid |
docs |
body_encoding |
required | Parameters are in the query or a URL-encoded form body. JSON is not this API. Complete HTTP capture contract. Native JSON type: string. | vendor.singular.http.body_encoding.missingvendor.singular.http.body_encoding.emptyvendor.singular.http.body_encoding.invalid |
docs |
content_type |
required | A submitted form body requires application/x-www-form-urlencoded. Complete HTTP capture contract. Applies when {"kind":"value_in","param":"body_encoding","values":["form"]}. Native JSON type: string. | vendor.singular.http.content_type.missingvendor.singular.http.content_type.emptyvendor.singular.http.content_type.invalid |
docs |
url |
required | The published request endpoint uses HTTPS. Complete HTTP capture contract. Native JSON type: string. | vendor.singular.http.url.missingvendor.singular.http.url.emptyvendor.singular.http.url.invalid |
docs |
http.form_requires_post |
required | URL-encoded request bodies use POST; GET events send query parameters. Complete HTTP capture contract. | vendor.singular.http.form_requires_post |
docs |
Validate a payload
pixellint validate url "$ARTIFACT" --rulepack vendor/singular
Try this failing payload in the playground. Singular EVENT missing a.
https://s2s.singular.net/api/v1/evt?n=purchase
cargo install pixellint
·
npm install pixellint