{"openapi":"3.1.0","info":{"title":"DEV3 Nudgeflare API","version":"1.0.0"},"servers":[{"url":"/api/v1"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"n3k_…"}}},"paths":{"/sites":{"get":{"summary":"List sites (VAPID public key included, private key never)","tags":["Sites"],"security":[{"bearer":[]}],"x-scope":"campaigns:read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"next":{"type":["string","null"]}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/sites/{id}":{"get":{"summary":"Get a site","tags":["Sites"],"security":[{"bearer":[]}],"x-scope":"campaigns:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/subscribers":{"get":{"summary":"List subscribers (masked endpoint hash, never the endpoint or keys)","tags":["Subscribers"],"security":[{"bearer":[]}],"x-scope":"subscribers:read","parameters":[{"name":"siteId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","expired","unsubscribed","over_cap"]}},{"name":"tag","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"externalId","in":"query","required":false,"schema":{"type":"string","maxLength":128}},{"name":"limit","in":"query","required":true,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"next":{"type":["string","null"]}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/subscribers/{id}":{"get":{"summary":"Get a subscriber","tags":["Subscribers"],"security":[{"bearer":[]}],"x-scope":"subscribers:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Update tags, attributes or the external id","tags":["Subscribers"],"security":[{"bearer":[]}],"x-scope":"subscribers:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"addTags":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9 _:.\\-/]{0,63}$"}},"removeTags":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9 _:.\\-/]{0,63}$"}},"attributes":{"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,31}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"number"},{"type":"boolean"}]}},"externalId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"delete":{"summary":"Delete a subscriber","tags":["Subscribers"],"security":[{"bearer":[]}],"x-scope":"subscribers:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/segments":{"get":{"summary":"List segments","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"next":{"type":["string","null"]}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a segment (allow-listed rule builder)","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"siteIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"rules":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["name","siteIds","rules"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/segments/estimate":{"post":{"summary":"Estimate the audience of a saved segment or of ad-hoc rules","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:read","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"segmentId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"siteIds":{"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"rules":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"count":{"type":"number"},"at":{"anyOf":[{"type":"string"},{}]}},"required":["count","at"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/segments/{id}":{"get":{"summary":"Get a segment","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Update a segment","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"siteIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"rules":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"delete":{"summary":"Delete a segment","tags":["Segments"],"security":[{"bearer":[]}],"x-scope":"subscribers:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns":{"get":{"summary":"List campaigns","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:read","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","scheduled","sending","paused","sent","cancelled"]}},{"name":"limit","in":"query","required":true,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"next":{"type":["string","null"]}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a draft campaign (title ≤ 65, body ≤ 240, ≤ 2 buttons, optional A/B)","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"siteIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"segmentIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"variants":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-D]$"},"title":{"type":"string","minLength":1,"maxLength":65},"body":{"type":"string","minLength":1,"maxLength":240},"icon":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"image":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"buttons":{"default":[],"maxItems":2,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":24},"url":{"type":"string","maxLength":2048}},"required":["label","url"],"additionalProperties":false}},"url":{"type":"string","maxLength":2048},"utm":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","maxLength":120},"medium":{"type":"string","maxLength":120},"campaign":{"type":"string","maxLength":120},"term":{"type":"string","maxLength":120},"content":{"type":"string","maxLength":120}},"additionalProperties":false},{"type":"null"}]}},"required":["key","title","body","buttons","url"],"additionalProperties":false}},"ab":{"default":{"enabled":false,"testPct":20,"metric":"ctr","decideAfterHours":4,"minClicks":100,"fallback":"A"},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"testPct":{"default":20,"type":"integer","minimum":5,"maximum":50},"metric":{"default":"ctr","type":"string","const":"ctr"},"decideAfterHours":{"default":4,"type":"integer","minimum":1,"maximum":168},"minClicks":{"default":100,"type":"integer","minimum":1,"maximum":100000},"fallback":{"default":"A","type":"string","enum":["A","both"]}},"required":["enabled","testPct","metric","decideAfterHours","minClicks","fallback"],"additionalProperties":false},"schedule":{"default":{"mode":"now","throttlePerMin":0},"type":"object","properties":{"mode":{"default":"now","type":"string","enum":["now","at","local"]},"at":{},"localDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"localTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"throttlePerMin":{"default":0,"type":"integer","minimum":0,"maximum":1000000}},"required":["mode","throttlePerMin"],"additionalProperties":false},"ttl":{"default":86400,"type":"integer","minimum":0,"maximum":2419200},"urgency":{"default":"normal","type":"string","enum":["very-low","low","normal","high"]}},"required":["name","siteIds","segmentIds","variants","ab","schedule","ttl","urgency"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns/{id}":{"get":{"summary":"Get a campaign","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Replace a draft campaign","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"siteIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"segmentIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"variants":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-D]$"},"title":{"type":"string","minLength":1,"maxLength":65},"body":{"type":"string","minLength":1,"maxLength":240},"icon":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"image":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"buttons":{"default":[],"maxItems":2,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":24},"url":{"type":"string","maxLength":2048}},"required":["label","url"],"additionalProperties":false}},"url":{"type":"string","maxLength":2048},"utm":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","maxLength":120},"medium":{"type":"string","maxLength":120},"campaign":{"type":"string","maxLength":120},"term":{"type":"string","maxLength":120},"content":{"type":"string","maxLength":120}},"additionalProperties":false},{"type":"null"}]}},"required":["key","title","body","buttons","url"],"additionalProperties":false}},"ab":{"default":{"enabled":false,"testPct":20,"metric":"ctr","decideAfterHours":4,"minClicks":100,"fallback":"A"},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"testPct":{"default":20,"type":"integer","minimum":5,"maximum":50},"metric":{"default":"ctr","type":"string","const":"ctr"},"decideAfterHours":{"default":4,"type":"integer","minimum":1,"maximum":168},"minClicks":{"default":100,"type":"integer","minimum":1,"maximum":100000},"fallback":{"default":"A","type":"string","enum":["A","both"]}},"required":["enabled","testPct","metric","decideAfterHours","minClicks","fallback"],"additionalProperties":false},"schedule":{"default":{"mode":"now","throttlePerMin":0},"type":"object","properties":{"mode":{"default":"now","type":"string","enum":["now","at","local"]},"at":{},"localDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"localTime":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"throttlePerMin":{"default":0,"type":"integer","minimum":0,"maximum":1000000}},"required":["mode","throttlePerMin"],"additionalProperties":false},"ttl":{"default":86400,"type":"integer","minimum":0,"maximum":2419200},"urgency":{"default":"normal","type":"string","enum":["very-low","low","normal","high"]}},"required":["name","siteIds","segmentIds","variants","ab","schedule","ttl","urgency"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"delete":{"summary":"Delete a draft or cancelled campaign","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns/{id}/send":{"post":{"summary":"Send now (exactly one delivery per subscriber, even if called twice)","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:send","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns/{id}/schedule":{"post":{"summary":"Schedule at a UTC time or at a local time per timezone","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:send","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mode":{"type":"string","enum":["at","local"]},"at":{"type":"string"},"localDate":{"type":"string"},"localTime":{"type":"string"},"throttlePerMin":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["mode"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns/{id}/cancel":{"post":{"summary":"Cancel a campaign","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:send","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"}},"required":["ok"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/campaigns/{id}/stats":{"get":{"summary":"Results per variant and per timezone wave","tags":["Campaigns"],"security":[{"bearer":[]}],"x-scope":"campaigns:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/automations/{key}/trigger":{"post":{"summary":"Trigger an API automation for subscribers (idempotent per key)","tags":["Automations"],"security":[{"bearer":[]}],"x-scope":"automations:trigger","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"externalIds":{"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"subscriberIds":{"maxItems":1000,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{24}$"}},"segmentId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"idempotencyKey":{"type":"string","minLength":8,"maxLength":128},"override":{"type":"object","properties":{"title":{"type":"string","maxLength":65},"body":{"type":"string","maxLength":240},"url":{"type":"string","maxLength":2048}},"additionalProperties":false}},"required":["idempotencyKey"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/notifications":{"post":{"summary":"One-off transactional push to an external id","tags":["Notifications"],"security":[{"bearer":[]}],"x-scope":"automations:trigger","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"externalId":{"type":"string","minLength":1,"maxLength":128},"siteId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"idempotencyKey":{"type":"string","minLength":8,"maxLength":128},"content":{"type":"object","properties":{"title":{"type":"string","maxLength":65},"body":{"type":"string","maxLength":240},"url":{"type":"string","maxLength":2048},"icon":{"type":["string","null"]},"image":{"type":["string","null"]},"buttons":{"maxItems":2,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","maxLength":24},"url":{"type":"string","maxLength":2048}},"required":["label","url"],"additionalProperties":false}}},"required":["title","body","url"],"additionalProperties":false},"ttl":{"type":"integer","minimum":0,"maximum":2419200},"urgency":{"type":"string","enum":["very-low","low","normal","high"]}},"required":["externalId","idempotencyKey","content"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/analytics":{"get":{"summary":"Daily delivery and click analytics","tags":["Analytics"],"security":[{"bearer":[]}],"x-scope":"analytics:read","parameters":[{"name":"siteId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"totals":{"type":"object","properties":{},"additionalProperties":{}}},"required":["data","totals"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}}}}