Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.
GET
/
conversion-event
/
{eventId}
cURL
curl --request GET \ --url https://{host}/api/v1/conversion-event/{eventId} \ --header 'Authorization: <api-key>'
import { createSiteClient } from '@fetchski/attract-cms-sdk';
const site = createSiteClient();
const getConversionEvent = await site.conversionEvents().getConversionEvent({ eventId: 'tenant-42:order:1234:purchase' });
use Fetchski\AttractCmsLaravel\Facades\Attract;
$getConversionEvent = Attract::conversionEvents()->getConversionEvent(eventId: 'tenant-42:order:1234:purchase');
{
"name": "unauthorized",
"message": "X-Fetchski-Signature does not match this request.",
"data": {}
}
{
"name": "forbidden",
"message": "This API key lacks the required scope: conversions:read.",
"data": {}
}
{
"name": "notfound",
"message": "No event with this ID.",
"data": {}
}
{
"name": "tooManyRequests",
"message": "This API key’s rate limit is used up for this minute.",
"data": {
"retryAfter": 12
}
}
Authorizations
Authorization
string
header
required
Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.
Scopes
conversions:read
Path Parameters
eventId
string
required
The event ID.
Opaque, unique per site, stable. The CMS mints a UUID for events it originates; another system mints its own (e.g. tenant-42:order:1234:purchase). Forwarded unchanged to every ad platform as its de-duplication key.
Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
Example:
"tenant-42:order:1234:purchase"
Response
The event.
event
object
required
One conversion occurrence. Fields the visitor’s consent did not allow are ABSENT, not empty. Never returned: the visitor’s IP address and user agent, outbox lease and retry bookkeeping.
{
"name": "unauthorized",
"message": "X-Fetchski-Signature does not match this request.",
"data": {}
}
{
"name": "forbidden",
"message": "This API key lacks the required scope: conversions:read.",
"data": {}
}
{
"name": "notfound",
"message": "No event with this ID.",
"data": {}
}
{
"name": "tooManyRequests",
"message": "This API key’s rate limit is used up for this minute.",
"data": {
"retryAfter": 12
}
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Fetchski Attract Docs","colors":{"primary":"#16a34a","light":"#22c55e","dark":"#15803d"},"logo":{"light":"https://mintcdn.com/fetchski-attract-api/mn9qfQRsqaASh7UE/logo/light.svg?fit=max\u0026auto=format\u0026n=mn9qfQRsqaASh7UE\u0026q=85\u0026s=66db13e248b70a44a5ff5f6990d4cb63","dark":"https://mintcdn.com/fetchski-attract-api/mn9qfQRsqaASh7UE/logo/dark.svg?fit=max\u0026auto=format\u0026n=mn9qfQRsqaASh7UE\u0026q=85\u0026s=86904ba8d47714303521b2dcd5aa2a50","href":"/"},"favicon":"https://mintcdn.com/fetchski-attract-api/mn9qfQRsqaASh7UE/favicon.svg?fit=max\u0026auto=format\u0026n=mn9qfQRsqaASh7UE\u0026q=85\u0026s=fd4f2c0615961c9e01c9762b98c8999f","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","typescript","php"]}},"appearance":{"default":"dark"},"background":{"color":{"light":"#ffffff","dark":"#0b0e13"}},"search":{"prompt":"Search the docs…"},"seo":{"metatags":{"robots":"noindex, nofollow"}},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"codeblocks":"dark","latex":true},"contextual":{"options":["copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fetchski-attract-api","hasAudioNarration":false,"actualSubdomain":"fetchski-attract-api","customDomains":["docs.fetchski-attract.com"],"gitSource":{"type":"github","owner":"fetchski","repo":"fetchski_cms_astro_monorepo","deployBranch":"main","contentDirectory":"docs/attract","isPrivate":true,"mountPath":"","label":"","_id":"6adb9c232f0947a18a27541d"},"entitlements":{},"buildId":"6af6df04bd8b0362cdec74ff","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"Media","count":953},{"language":"default","tag":"Content","count":863},{"language":"default","tag":"Publishing","count":720},{"language":"default","tag":"API reference","count":484},{"language":"default","tag":"Laravel","count":472},{"language":"default","tag":"TypeScript","count":470},{"language":"default","tag":"AdonisJS","count":469},{"language":"default","tag":"Batch jobs","count":364},{"language":"default","tag":"Pages \u0026 Site","count":224},{"language":"default","tag":"Forms","count":168}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1280px){:root{--content-width: 52rem}}@media (min-width: 1600px){:root{--content-width: 60rem}}@media (min-width: 1920px){:root{--content-width: 68rem}}@media (min-width: 1024px) and (max-width: 1919px){#content-container{padding-left:2rem;padding-right:2rem}div:has(>#content-area){padding-left:0}#table-of-contents{width:14rem}}html[data-page-mode=\"wide\"] #content-area{max-width:84rem}@media (min-width: 1024px){#navbar .nav-tabs{position:fixed;left:15rem;top:0;height:6rem}}@media (min-width: 1024px) and (max-width: 1599px){#navbar .nav-tabs{gap:0}#navbar .nav-tabs .nav-tabs-item{gap:0.375rem;font-size:0.9375rem;padding-inline:0.5rem}#navbar .nav-tabs .nav-tabs-item svg,#navbar .nav-tabs .nav-tabs-item img{width:1.0625rem;height:1.0625rem}}@media (min-width: 1024px) and (max-width: 1199px){#navbar .nav-tabs .nav-tabs-item svg,#navbar .nav-tabs .nav-tabs-item img{display:none}}@media (min-width: 1024px) and (max-width: 1319px){div:has(>#search-bar-entry){width:3rem!important}#search-bar-entry{justify-content:center;padding:0!important}#search-bar-entry>div>:not(svg),#search-bar-entry>:not(div){display:none}}.mdx-content{font-size:1.0625rem;line-height:1.8}@media (min-width: 1024px){.mdx-content{font-size:1.25rem;line-height:1.85}#page-title{font-size:2.875rem;line-height:1.15}#page-title+*,#header .prose{font-size:1.375rem}#sidebar-content a{font-size:1.125rem}.toc-item{font-size:1rem}}.mdx-content>[data-as=\"p\"],.mdx-content>p{margin-top:0;margin-bottom:1.75rem}.mdx-content>h2{margin-top:3.5rem;margin-bottom:1.25rem;padding-top:2rem;border-top:1px solid rgb(0 0 0 / 0.08);font-size:1.875rem;letter-spacing:-0.01em}.dark .mdx-content>h2{border-top-color:rgb(255 255 255 / 0.08)}.mdx-content>h2:first-child{margin-top:0;padding-top:0;border-top:0}.mdx-content>h3{margin-top:2.75rem;margin-bottom:1.125rem;font-size:1.4375rem}.mdx-content>h4{margin-top:2rem;margin-bottom:0.75rem}.mdx-content li{margin-top:0.625rem;margin-bottom:0.625rem}.mdx-content>ul,.mdx-content>ol{margin-bottom:1.75rem}.mdx-content :not(pre)>code{font-size:0.875em;padding:0.125rem 0.375rem;overflow-wrap:anywhere}.mdx-content table{font-size:1.0625rem;line-height:1.7}.mdx-content th,.mdx-content td{padding:0.875rem 1.5rem 0.875rem 0!important;vertical-align:top}.mdx-content th{padding-top:0.25rem!important}.mdx-content th:last-child,.mdx-content td:last-child{padding-right:0!important}.mdx-content td>code:only-child{white-space:nowrap}pre{max-height:36rem;overflow:auto}.mdx-content pre code{font-size:0.9375rem;line-height:1.75}.mdx-content>.code-block,.mdx-content>.code-group{margin-top:1.5rem;margin-bottom:2rem}.mdx-content .columns{column-gap:1.25rem;row-gap:0.5rem;margin-top:1.75rem;margin-bottom:2.25rem}.mdx-content .card{border-radius:1rem}.mdx-content .card [data-component-part=\"card-content-container\"]{padding:1.5rem 1.75rem}.mdx-content [data-component-part=\"card-title\"]{font-size:1.25rem}.mdx-content [data-component-part=\"card-content\"]{font-size:1.0625rem;line-height:1.7}.mdx-content .callout{margin-top:2rem;margin-bottom:2.25rem;padding:1.25rem 1.75rem;font-size:1.125rem;line-height:1.75}.mdx-content .steps{margin-top:1.75rem;margin-bottom:2.25rem}.mdx-content .step{padding-bottom:0.75rem}.mdx-content .accordion-group,.mdx-content>.accordion{margin-top:1.75rem;margin-bottom:2.25rem}.mdx-content .tabs{margin-top:1.75rem;margin-bottom:2.25rem}.mdx-content .tabs [role=\"tabpanel\"]{padding-top:0.375rem;padding-right:0.375rem;padding-bottom:0.375rem}.mdx-content [data-component-name=\"mermaid-container\"]{--im-node-fill: #ecfdf3;--im-node-stroke: #16a34a;--im-node-text: #0b3a1f;--im-cluster-fill: rgb(22 163 74 / 0.04);--im-cluster-stroke: rgb(22 163 74 / 0.35);--im-edge: #64748b;--im-label-bg: #ffffff;margin-top:1.75rem;margin-bottom:2.25rem;padding:2rem 1.5rem;border:1px solid rgb(0 0 0 / 0.08);border-radius:1rem;background:rgb(0 0 0 / 0.015)}.dark .mdx-content [data-component-name=\"mermaid-container\"]{--im-node-fill: #0b2e1a;--im-node-stroke: #22c55e;--im-node-text: #e7fbef;--im-cluster-fill: rgb(34 197 94 / 0.05);--im-cluster-stroke: rgb(34 197 94 / 0.35);--im-edge: #94a3b8;--im-label-bg: #0f1214;border-color:rgb(255 255 255 / 0.08);background:rgb(255 255 255 / 0.02)}.mdx-content [data-component-name=\"mermaid-container\"] svg[id^=\"mermaid\"]{display:block;margin-left:auto;margin-right:auto}.mdx-content [data-component-name=\"mermaid-container\"] .node rect,.mdx-content [data-component-name=\"mermaid-container\"] .node polygon,.mdx-content [data-component-name=\"mermaid-container\"] .node circle,.mdx-content [data-component-name=\"mermaid-container\"] .node path{fill:var(--im-node-fill)!important;stroke:var(--im-node-stroke)!important;stroke-width:1.5px!important}.mdx-content [data-component-name=\"mermaid-container\"] .node rect{rx:8px;ry:8px}.mdx-content [data-component-name=\"mermaid-container\"] .nodeLabel,.mdx-content [data-component-name=\"mermaid-container\"] .node .label{color:var(--im-node-text)!important;fill:var(--im-node-text)!important}.mdx-content [data-component-name=\"mermaid-container\"] .cluster rect{fill:var(--im-cluster-fill)!important;stroke:var(--im-cluster-stroke)!important;stroke-dasharray:6 4;rx:12px;ry:12px}.mdx-content [data-component-name=\"mermaid-container\"] .cluster-label .nodeLabel,.mdx-content [data-component-name=\"mermaid-container\"] .cluster .nodeLabel{color:var(--im-node-stroke)!important}.mdx-content [data-component-name=\"mermaid-container\"] .flowchart-link,.mdx-content [data-component-name=\"mermaid-container\"] .edgePath path{stroke:var(--im-edge)!important;stroke-width:1.5px!important}.mdx-content [data-component-name=\"mermaid-container\"] marker path,.mdx-content [data-component-name=\"mermaid-container\"] .arrowheadPath{fill:var(--im-edge)!important;stroke:var(--im-edge)!important}.mdx-content [data-component-name=\"mermaid-container\"] .edgeLabel,.mdx-content [data-component-name=\"mermaid-container\"] .edgeLabel p,.mdx-content [data-component-name=\"mermaid-container\"] .labelBkg{background-color:var(--im-label-bg)!important;color:var(--im-edge)!important}.mdx-content [data-component-name=\"mermaid-container\"] rect.actor{fill:var(--im-node-fill)!important;stroke:var(--im-node-stroke)!important;stroke-width:1.5px!important;rx:8px;ry:8px}.mdx-content [data-component-name=\"mermaid-container\"] text.actor>tspan,.mdx-content [data-component-name=\"mermaid-container\"] text.actor{fill:var(--im-node-text)!important}.mdx-content [data-component-name=\"mermaid-container\"] .actor-line{stroke:var(--im-cluster-stroke)!important}.mdx-content [data-component-name=\"mermaid-container\"] .messageLine0,.mdx-content [data-component-name=\"mermaid-container\"] .messageLine1{stroke:var(--im-edge)!important;stroke-width:1.5px!important}.mdx-content [data-component-name=\"mermaid-container\"] #arrowhead path,.mdx-content [data-component-name=\"mermaid-container\"] #crosshead path{fill:var(--im-edge)!important;stroke:var(--im-edge)!important}.mdx-content [data-component-name=\"mermaid-container\"] .note{fill:var(--im-cluster-fill)!important;stroke:var(--im-cluster-stroke)!important}.mdx-content .field .prose-sm{font-size:1.0625rem;line-height:1.8}@media (min-width: 1024px){.mdx-content .field .prose-sm{font-size:1.125rem}}.mdx-content .field{padding-top:1.25rem;padding-bottom:1.25rem}:root{--fa-accent: 22 163 74;--fa-ink: 15 23 42;--fa-button: 21 128 61;--fa-button-hover: 22 101 52;--fa-on-button: 255 255 255}.dark{--fa-accent: 34 197 94;--fa-ink: 255 255 255;--fa-button: 34 197 94;--fa-button-hover: 74 222 128;--fa-on-button: 5 46 22}.mdx-content .card{transition:border-color 150ms ease,\n background-color 150ms ease}.mdx-content a.card:hover,.mdx-content .card:has(a:hover){border-color:rgb(var(--fa-accent) / 0.45);background-color:rgb(var(--fa-accent) / 0.06)}.mdx-content .card [data-component-part=\"card-icon\"]{display:flex;width:1.75rem;height:1.75rem;margin-bottom:1rem}.mdx-content .card [data-component-part=\"card-icon\"] svg{width:1.75rem;height:1.75rem;mask-size:contain;background-color:rgb(var(--fa-accent))!important}.mdx-content .card [data-component-part=\"card-content-container\"].flex [data-component-part=\"card-icon\"]{margin-bottom:0}html[data-page-mode=\"wide\"] #header{display:none}.fa-hero{position:relative;isolation:isolate;display:grid;grid-template-columns:minmax(0, 1fr);gap:3rem;align-items:center;overflow:hidden;margin:-1.5rem 0 3.5rem;padding:3.5rem 3rem;border:1px solid rgb(var(--fa-accent) / 0.2);border-radius:1.5rem;background-color:rgb(var(--fa-accent) / 0.025);background-image:radial-gradient(\n 55% 75% at 82% 50%,\n rgb(var(--fa-accent) / 0.16),\n transparent 70%\n )}.fa-hero::before{content:'';position:absolute;inset:0;z-index:-1;background-image:linear-gradient(rgb(var(--fa-accent) / 0.1) 1px, transparent 1px),\n linear-gradient(90deg, rgb(var(--fa-accent) / 0.1) 1px, transparent 1px);background-size:2rem 2rem;background-position:-1px -1px;mask-image:radial-gradient(80% 90% at 85% 40%, #000 20%, transparent 75%);pointer-events:none}.fa-hero::after{content:'';position:absolute;top:0;right:10%;left:10%;height:1px;background:linear-gradient(\n 90deg,\n transparent,\n rgb(var(--fa-accent) / 0.8),\n transparent\n );pointer-events:none}@media (min-width: 1536px){.fa-hero{grid-template-columns:minmax(0, 0.85fr) minmax(0, 1.15fr);padding:4rem 3.5rem}}.fa-hero-code>.code-group,.fa-hero-code>.code-block{margin:0;border-color:rgb(var(--fa-accent) / 0.25);box-shadow:0 1px 0 rgb(255 255 255 / 0.04) inset,\n 0 30px 60px -24px rgb(0 0 0 / 0.55),\n 0 0 0 6px rgb(var(--fa-accent) / 0.06)}.mdx-content .fa-hero-code pre code{font-size:0.8125rem}.mdx-content .fa-hero .fa-hero-mark{margin:0 0 1.75rem}.mdx-content .fa-hero .fa-hero-mark img{display:block;width:auto;height:4rem;margin:0;border-radius:0}.mdx-content .fa-hero .fa-hero-mark .fa-hero-mark-dark,.dark .mdx-content .fa-hero .fa-hero-mark .fa-hero-mark-light{display:none}.dark .mdx-content .fa-hero .fa-hero-mark .fa-hero-mark-dark{display:block}.fa-hero h1{max-width:40rem;margin:0;font-size:3.25rem;font-weight:700;line-height:1.06;letter-spacing:-0.035em;text-wrap:balance}.fa-hero h1 .fa-hero-accent{color:rgb(var(--fa-accent))}.mdx-content .fa-hero-lede{max-width:34rem;margin:1.5rem 0 2.25rem;font-size:1.1875rem;line-height:1.7;opacity:0.78;text-wrap:pretty}.fa-hero-actions{display:flex;flex-wrap:wrap;gap:0.75rem}.mdx-content .fa-hero-facts{display:flex;flex-wrap:wrap;gap:0.5rem 1.5rem;margin-top:2rem;font-size:0.9375rem;opacity:0.8}.mdx-content .fa-hero-facts>span{display:inline-flex;align-items:center;gap:0.5rem}.mdx-content .fa-hero-facts>span::before{content:'';flex:none;width:1rem;height:1rem;background:rgb(var(--fa-accent));mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath d='M3.5 8.5l3 3 6-7' fill='none' stroke='%23000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/svg%3E\")\n center / contain no-repeat}.fa-button{display:inline-flex;align-items:center;gap:0.5rem;height:2.75rem;padding:0 1.125rem;border:1px solid transparent;border-radius:0.625rem;font-size:0.9375rem;font-weight:600;letter-spacing:-0.005em;text-decoration:none!important;transition:background-color 150ms ease,\n border-color 150ms ease,\n box-shadow 150ms ease,\n transform 150ms ease}.fa-button-primary{border-color:rgb(var(--fa-button) / 1);background:rgb(var(--fa-button));box-shadow:inset 0 1px 0 rgb(255 255 255 / 0.25),\n 0 8px 20px -10px rgb(var(--fa-button) / 0.9);color:rgb(var(--fa-on-button))!important}.fa-button-primary::after{content:'';width:1rem;height:1rem;background:currentcolor;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath d='M3 8h9.5M8.5 4l4 4-4 4' fill='none' stroke='%23000' stroke-width='1.75' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/svg%3E\")\n center / contain no-repeat;transition:transform 150ms ease}.fa-button-primary:hover{background:rgb(var(--fa-button-hover));box-shadow:inset 0 1px 0 rgb(255 255 255 / 0.25),\n 0 10px 24px -10px rgb(var(--fa-button) / 1)}.fa-button-primary:hover::after{transform:translateX(2px)}.fa-button-secondary{border-color:rgb(var(--fa-ink) / 0.16);background:rgb(var(--fa-ink) / 0.03);color:inherit!important}.fa-button-secondary:hover{border-color:rgb(var(--fa-accent) / 0.55);background:rgb(var(--fa-accent) / 0.08)}.fa-button:active{transform:translateY(1px)}.fa-button:focus-visible{outline:2px solid rgb(var(--fa-accent));outline-offset:3px}@media (prefers-reduced-motion: reduce){.fa-button,.fa-button-primary::after{transition:none}.fa-button:active,.fa-button-primary:hover::after{transform:none}}@media (max-width: 767px){.fa-hero{padding:2.5rem 1.5rem}.fa-hero h1{font-size:2.25rem}}#sidebar-content a,#sidebar-content li>button{gap:0.875rem;padding-top:0.625rem;padding-right:0.5rem;padding-bottom:0.625rem;font-size:1.125rem;line-height:1.45}#sidebar-content li+li{margin-top:0.25rem}#sidebar-content li>button>div:nth-child(2){min-width:0}#sidebar-content li>button>div:last-child{width:1.25rem;margin-left:auto;justify-content:center}#sidebar-content li>ul{margin:0.25rem 0 0.25rem 1.25rem;padding-left:0.375rem;border-left:1px solid rgb(0 0 0 / 0.1)}.dark #sidebar-content li>ul{border-left-color:rgb(255 255 255 / 0.1)}#sidebar-content li>ul>li>:is(a,button){padding-left:0.75rem!important;font-size:1.0625rem}#sidebar-content .sidebar-group-header{margin-bottom:0.625rem;font-size:0.875rem;font-weight:700;letter-spacing:0.08em;text-transform:uppercase;color:color-mix(in srgb, rgb(var(--fa-accent)) 72%, black)}.dark #sidebar-content .sidebar-group-header{color:rgb(var(--fa-accent))}#sidebar-content div:has(>.sidebar-group-header)+div:has(>.sidebar-group-header){margin-top:2.25rem}#sidebar-content a svg,#sidebar-content a img,#sidebar-content li>button>div:first-child svg,#sidebar-content li>button>div:first-child img{width:1.375rem;height:1.375rem}#sidebar-content .sidebar-group-header svg{width:1rem;height:1rem}.nav-tabs-item{gap:0.625rem;font-size:1.0625rem}.nav-tabs-item svg,.nav-tabs-item img{width:1.3125rem;height:1.3125rem}.nav-tabs-item[href^=\"/typescript\"] svg{background-color:#d4b106}.dark .nav-tabs-item[href^=\"/typescript\"] svg{background-color:#f7df1e}.nav-tabs-item[href^=\"/laravel\"] svg{background-color:#ff2d20}.nav-tabs-item[href^=\"/adonisjs\"] svg{background-color:#5a45ff}.dark .nav-tabs-item[href^=\"/adonisjs\"] svg{background-color:#8b7dff}li[data-group-tag]>button svg[style*=\"/brands/js.svg\"]{background-color:#d4b106}.dark li[data-group-tag]>button svg[style*=\"/brands/js.svg\"]{background-color:#f7df1e}li[data-group-tag]>button svg[style*=\"/brands/laravel.svg\"]{background-color:#ff2d20}#sidebar-content img[src$=\"/n8n.png\"]{transform:scale(1.35)}@media (min-width: 1024px){:root{--mintlify-slot-header-height: 6rem;--sidebar-width: 26rem}#navbar{height:6rem}#sidebar-content{top:6rem}#navbar div:has(img.nav-logo){height:100%}img.nav-logo{height:3.5rem;margin-left:0.5rem}div:has(>#search-bar-entry){position:fixed;top:1.5rem;right:7rem;z-index:40;width:clamp(11rem, calc(100vw - var(--sidebar-width) - 45rem), 24rem)}#search-bar-entry{height:3rem;padding-left:1.125rem;border-radius:0.875rem;font-size:1.0625rem}#search-bar-entry svg{width:1.125rem;height:1.125rem}}[data-switch=\"pill\"]{width:auto!important;height:auto!important;padding:0.3125rem;gap:0.25rem}.switch-option{width:2.125rem!important;height:2.125rem!important}.switch-option svg{width:1.125rem;height:1.125rem}.mdx-content .accordion-group{display:grid;gap:0.75rem;overflow:visible;border:0;border-color:transparent;border-radius:0;background:none}.mdx-content details.accordion{margin:0 0 0.75rem;border-color:transparent;border-radius:1rem!important;outline:1px solid rgb(var(--fa-ink) / 0.1);outline-offset:-1px;overflow:hidden;transition:outline-color 150ms ease,\n box-shadow 150ms ease}.mdx-content .accordion-group>details.accordion{margin:0}.mdx-content details.accordion:hover{outline-color:rgb(var(--fa-accent) / 0.35)}.mdx-content details.accordion[open]{outline-color:rgb(var(--fa-accent) / 0.45);box-shadow:inset 3px 0 0 rgb(var(--fa-accent))}.mdx-content [data-component-part=\"accordion-button\"]{gap:1rem;padding:1rem 1.25rem 1rem 1.5rem;border-radius:0!important;transition:background-color 150ms ease}.mdx-content [data-component-part=\"accordion-button\"]:hover{background:rgb(var(--fa-accent) / 0.05)}.mdx-content [data-component-part=\"accordion-button\"]:focus-visible{outline:2px solid rgb(var(--fa-accent));outline-offset:-2px}.mdx-content [data-component-part=\"accordion-caret-right\"]{order:3;width:2rem;height:2rem;border-radius:999px;background:rgb(var(--fa-ink) / 0.06);transition:background-color 150ms ease}.mdx-content [data-component-part=\"accordion-caret-right\"] svg{width:0.875rem;height:0.875rem}.mdx-content details.accordion[open] [data-component-part=\"accordion-caret-right\"]{background:rgb(var(--fa-accent) / 0.15)}.mdx-content details.accordion[open] [data-component-part=\"accordion-caret-right\"] svg{color:rgb(var(--fa-accent))}.mdx-content [data-component-part=\"accordion-icon\"]{display:inline-flex;align-items:center;justify-content:center;width:1.25rem;height:1.25rem}.mdx-content [data-component-part=\"accordion-icon\"] svg{width:1.25rem;height:1.25rem;background-color:rgb(var(--fa-accent))!important}.mdx-content [data-component-part=\"accordion-title\"]{font-size:1.1875rem}.mdx-content [data-component-part=\"accordion-content\"]{max-width:none;padding:1.5rem 2rem 1.75rem 1.5rem;border-top:1px solid rgb(var(--fa-ink) / 0.08);font-size:1.125rem;line-height:1.95}@media (min-width: 768px){.mdx-content details.accordion:has(>summary [data-component-part=\"accordion-icon\"])>[data-component-part=\"accordion-content\"]{padding-left:3.75rem}}.mdx-content [data-component-part=\"accordion-content\"]>[data-as=\"p\"],.mdx-content [data-component-part=\"accordion-content\"]>p{display:block;max-width:46rem;margin:0 0 1.25rem}.mdx-content [data-component-part=\"accordion-content\"]>:last-child{margin-bottom:0}@media (prefers-reduced-motion: reduce){.mdx-content details.accordion,.mdx-content [data-component-part=\"accordion-button\"],.mdx-content [data-component-part=\"accordion-caret-right\"]{transition:none}}[data-badge=\"true\"]{--fa-badge: 100 116 139;padding:0.125rem 0.5rem;border-radius:0.5rem;background:rgb(var(--fa-badge) / 0.14)!important;box-shadow:inset 0 0 0 1px rgb(var(--fa-badge) / 0.32);color:rgb(var(--fa-badge))!important;font-variant-numeric:tabular-nums}[data-badge=\"true\"][data-color=\"red\"]{--fa-badge: 239 68 68}[data-badge=\"true\"][data-color=\"orange\"]{--fa-badge: 245 130 32}[data-badge=\"true\"][data-color=\"yellow\"]{--fa-badge: 214 160 20}[data-badge=\"true\"][data-color=\"green\"]{--fa-badge: 22 163 74}[data-badge=\"true\"][data-color=\"blue\"]{--fa-badge: 17 145 240}.dark [data-badge=\"true\"][data-color=\"red\"]{--fa-badge: 248 113 113}.dark [data-badge=\"true\"][data-color=\"orange\"]{--fa-badge: 251 158 75}.dark [data-badge=\"true\"][data-color=\"yellow\"]{--fa-badge: 250 204 21}.dark [data-badge=\"true\"][data-color=\"green\"]{--fa-badge: 74 222 128}.dark [data-badge=\"true\"][data-color=\"blue\"]{--fa-badge: 62 165 245}.dark [data-badge=\"true\"][data-color=\"gray\"]{--fa-badge: 161 161 170}.mdx-content td [data-badge=\"true\"]+[data-badge=\"true\"]{margin-left:0.375rem}.mdx-content :is([data-as=\"p\"],p,li,td,blockquote),#header .prose,#page-title+*{color:rgb(38 43 52)}.dark .mdx-content :is([data-as=\"p\"],p,li,td,blockquote),.dark #header .prose,.dark #page-title+*{color:rgb(222 226 232)}.mdx-content :is(th,strong){font-weight:600}#sidebar-content a,#sidebar-content li>button{color:rgb(70 76 88)}.dark #sidebar-content a,.dark #sidebar-content li>button{color:rgb(196 201 210)}.toc-item a{color:inherit}.mdx-content [data-component-part=\"callout-content\"]{font-size:1.125rem;line-height:1.75}.mdx-content [data-component-part=\"callout-icon\"]{width:1.25rem;margin-top:0.25rem}.mdx-content [data-component-part=\"step-title\"]{font-size:1.25rem}.mdx-content [data-component-part=\"step-content\"],.mdx-content [data-component-part=\"tab-content\"]{font-size:1.125rem;line-height:1.85}.mdx-content [data-component-part=\"step-number\"]{margin-left:calc(0.5px - 1.125rem)}.mdx-content [data-component-part=\"step-indicator\"]{width:2.25rem;height:2.25rem;background-color:transparent;color:rgb(var(--fa-accent));font-size:1.25rem;font-weight:600}.mdx-content [data-component-part=\"step-indicator\"] svg{width:1.5rem;height:1.5rem;background-color:rgb(var(--fa-accent))!important}.mdx-content [data-component-part=\"tab-button\"]{font-size:1rem}.mdx-content [data-component-part=\"code-block-header\"],.mdx-content [data-component-part=\"code-block-header-filename\"]{font-size:0.875rem}.mdx-content [data-component-part=\"code-group-tab-bar\"]{font-size:0.9375rem}.mdx-content [data-component-part=\"field-name\"]{font-size:1.0625rem}.mdx-content [data-component-part=\"field-meta\"],.mdx-content [data-component-part=\"field-info-pill\"],.mdx-content [data-component-part=\"field-required-pill\"]{font-size:0.875rem}.mdx-content [data-component-part=\"expandable-button\"]{font-size:1rem}[data-component-part=\"pagination-title\"]{font-size:1.125rem}[data-component-part=\"pagination-label\"]{font-size:0.9375rem}.mdx-content>.multi-view-item{max-width:none;font-size:inherit;line-height:inherit}.multi-view-item>[data-as=\"p\"],.multi-view-item>p{margin-top:0;margin-bottom:1.75rem}.multi-view-item>h2{margin-top:3.5rem;margin-bottom:1.25rem;padding-top:2rem;border-top:1px solid rgb(0 0 0 / 0.08);font-size:1.875rem;letter-spacing:-0.01em}.dark .multi-view-item>h2{border-top-color:rgb(255 255 255 / 0.08)}.multi-view-item>h2:first-child{margin-top:0;padding-top:0;border-top:0}.multi-view-item>h3{margin-top:2.75rem;margin-bottom:1.125rem;font-size:1.4375rem}.multi-view-item>ul,.multi-view-item>ol{margin-bottom:1.75rem}.multi-view-item>.code-block,.multi-view-item>.code-group{margin-top:1.5rem;margin-bottom:2rem}#content-container .prose.prose-sm{font-size:1.0625rem;line-height:1.8}#sidebar-content .method-nav-pill{width:2.75rem}#sidebar-content .method-nav-pill>*{padding:0.125rem 0.375rem;font-size:0.6875rem;line-height:1.25rem}#fa-reader-values{margin-top:1.75rem;padding:1.5rem;border:1px solid rgb(var(--fa-ink) / 0.14);border-radius:1rem;background:transparent;font-size:1.0625rem;line-height:1.6;transition:border-color 150ms ease;container:fa-reader / inline-size}#fa-reader-values:hover,#fa-reader-values:focus-within{border-color:rgb(var(--fa-accent) / 0.45)}#fa-reader-values .fa-reader-line{display:grid;grid-template-columns:auto 1fr;align-items:center;gap:1rem 1.25rem}#fa-reader-values .fa-reader-toggle{grid-column:1 / -1;justify-self:start}@container fa-reader (min-width: 30rem){#fa-reader-values .fa-reader-line{grid-template-columns:auto 1fr auto}#fa-reader-values .fa-reader-line .fa-reader-toggle{grid-column:auto}}#fa-reader-values .fa-reader-icon{width:4rem;height:4rem;background:url('/logo/attract-glyph-color-a-green-on-light-scalable.svg') center / contain\n no-repeat}.dark #fa-reader-values .fa-reader-icon{background-image:url('/logo/attract-glyph-color-a-green-on-dark-scalable.svg')}#fa-reader-values .fa-reader-copy{min-width:0}#fa-reader-values .fa-reader-copy p{margin:0}#fa-reader-values .fa-reader-title{font-size:1.125rem;font-weight:600;color:rgb(var(--fa-ink))}#fa-reader-values .fa-reader-values{display:grid;grid-template-columns:auto 1fr;align-items:center;gap:0.625rem 0.875rem;margin:0.75rem 0 0}#fa-reader-values .fa-reader-values>div{display:contents}#fa-reader-values .fa-reader-values dt{font-weight:500;color:rgb(var(--fa-ink))}#fa-reader-values .fa-reader-values dd{justify-self:start;min-width:0;margin:0}#fa-reader-values code{display:inline-block;padding:0.375rem 0.875rem;border:1px solid rgb(var(--fa-accent) / 0.4);border-radius:0.5rem;background:rgb(var(--fa-ink) / 0.03);color:rgb(var(--fa-ink));font-size:0.95em;font-weight:700;line-height:1.4;overflow-wrap:anywhere}#fa-reader-values button{padding:0.625rem 1.25rem;border:1px solid rgb(var(--fa-ink) / 0.16);border-radius:0.625rem;background:rgb(var(--fa-ink) / 0.03);color:rgb(var(--fa-ink));font-weight:600;white-space:nowrap;cursor:pointer;transition:background-color 150ms ease,\n border-color 150ms ease}#fa-reader-values button:hover{border-color:rgb(var(--fa-accent) / 0.55);background:rgb(var(--fa-accent) / 0.08)}#fa-reader-values button:focus-visible,#fa-reader-values input:focus-visible{outline:2px solid rgb(var(--fa-accent));outline-offset:2px}#fa-reader-values .fa-reader-form{display:grid;grid-template-columns:1fr;gap:1.75rem 1.5rem;margin-top:1.5rem;padding:1.5rem 0.25rem 0.25rem;border-top:1px solid rgb(var(--fa-ink) / 0.1)}@media (min-width: 768px){#fa-reader-values .fa-reader-form{grid-template-columns:1fr 1fr}}#fa-reader-values .fa-reader-form[hidden]{display:none}#fa-reader-values label{display:grid;gap:0.625rem;align-content:start}#fa-reader-values label>span{font-weight:600;color:rgb(var(--fa-ink))}#fa-reader-values label em{font-style:normal;font-weight:400}#fa-reader-values input{width:100%;padding:0.75rem 1rem;border:1px solid rgb(128 128 128 / 0.4);border-radius:0.5rem;background:rgb(128 128 128 / 0.08);color:rgb(var(--fa-ink));font:inherit}#fa-reader-values small{display:block;margin-top:0.5rem;font-size:0.9375rem;line-height:1.6;color:rgb(var(--fa-ink))}#fa-reader-values .fa-reader-error{grid-column:1 / -1;margin:0;color:#dc2626}.dark #fa-reader-values .fa-reader-error{color:#f87171}#fa-reader-values .fa-reader-error:empty{display:none}#fa-reader-values .fa-reader-actions{display:flex;flex-wrap:wrap;grid-column:1 / -1;align-items:center;gap:1rem;padding-top:0.25rem}.mdx-content .n8n-canvas{--n8n-dot: rgb(0 0 0 / 0.12);--n8n-node-bg: #ffffff;--n8n-node-border: rgb(0 0 0 / 0.18);--n8n-line: #94a3b8;margin:1.75rem 0 2.25rem;padding:2rem 0.75rem 1.5rem;overflow-x:auto;border:1px solid rgb(0 0 0 / 0.08);border-radius:1rem;background-color:rgb(0 0 0 / 0.015);background-image:radial-gradient(var(--n8n-dot) 1px, transparent 1px);background-size:18px 18px}.dark .mdx-content .n8n-canvas{--n8n-dot: rgb(255 255 255 / 0.1);--n8n-node-bg: #1b1f24;--n8n-node-border: rgb(255 255 255 / 0.22);--n8n-line: #64748b;border-color:rgb(255 255 255 / 0.08);background-color:rgb(255 255 255 / 0.02)}.mdx-content .n8n-canvas-row{display:flex;align-items:flex-start;justify-content:center;min-width:max-content;margin:0 auto}.mdx-content .n8n-node{display:flex;flex-direction:column;align-items:center;width:7.25rem;text-align:center}.mdx-content .n8n-node-box{display:flex;align-items:center;justify-content:center;width:4.5rem;height:4.5rem;border:2px solid var(--n8n-node-border);border-radius:0.75rem;background:var(--n8n-node-bg);box-shadow:0 1px 3px rgb(0 0 0 / 0.08)}.mdx-content .n8n-node-trigger .n8n-node-box{border-radius:2.25rem 0.75rem 0.75rem 2.25rem}.mdx-content .n8n-node-accent .n8n-node-box{border-color:rgb(var(--fa-accent));box-shadow:0 0 0 4px rgb(var(--fa-accent) / 0.15)}.mdx-content .n8n-node-title{margin-top:0.6rem;font-size:0.95rem;font-weight:600;line-height:1.3}.mdx-content .n8n-node-note{margin-top:0.2rem;font-size:0.8rem;line-height:1.35;opacity:0.7}.mdx-content .n8n-node-box svg{width:1.9rem!important;height:1.9rem!important}.mdx-content .n8n-link{display:flex;flex-direction:column;align-items:center;width:4rem;margin:0 -1.125rem;padding-top:1.1rem}.mdx-content .n8n-link-items{height:1.1rem;font-size:0.75rem;font-weight:600;line-height:1.1rem;white-space:nowrap;color:rgb(var(--fa-accent))}.mdx-content .n8n-link-line{position:relative;width:100%;height:2px;margin-top:0.4rem;background:var(--n8n-line)}.mdx-content .n8n-link-line::after{position:absolute;top:-4px;right:-1px;border-top:5px solid transparent;border-bottom:5px solid transparent;border-left:7px solid var(--n8n-line);content:''}.mdx-content .n8n-canvas figcaption{margin-top:1.25rem;font-size:0.85rem;text-align:center;opacity:0.7}.mdx-content .n8n-signed{margin:1.5rem 0 2rem;padding:1.5rem 1.25rem 1.25rem;overflow-x:auto;border:1px solid rgb(0 0 0 / 0.08);border-radius:1rem}.dark .mdx-content .n8n-signed{border-color:rgb(255 255 255 / 0.08)}.mdx-content .n8n-signed-row{display:flex;flex-wrap:wrap;align-items:flex-start;justify-content:center;row-gap:1rem}.mdx-content .n8n-signed-part{display:flex;flex-direction:column;align-items:center;gap:0.5rem}.mdx-content .n8n-signed-value,.mdx-content .n8n-signed-dot{padding:0.35rem 0.55rem;border-radius:0.4rem;font-size:0.95rem;white-space:nowrap}.mdx-content .n8n-signed-dot{padding:0.35rem 0.15rem;background:none;font-weight:700}.mdx-content .n8n-signed-value{min-width:2.5rem;text-align:center;background:rgb(var(--n8n-part) / 0.14);box-shadow:inset 0 0 0 1px rgb(var(--n8n-part) / 0.45)}.mdx-content .n8n-signed-label{font-size:0.75rem;font-weight:600;letter-spacing:0.04em;text-transform:uppercase;color:rgb(var(--n8n-part))}.mdx-content .n8n-signed-0{--n8n-part: 37 99 235}.mdx-content .n8n-signed-1{--n8n-part: 22 163 74}.mdx-content .n8n-signed-2{--n8n-part: 217 119 6}.mdx-content .n8n-signed-3{--n8n-part: 219 39 119}.mdx-content .n8n-coming-soon-logos{display:flex;align-items:center;gap:1rem;margin-bottom:1.25rem}.mdx-content .n8n-coming-soon-logos img{width:auto;height:3.5rem;margin:0}.mdx-content .n8n-coming-soon-logos img[class^=\"n8n-mark-\"]{height:4.5rem;margin:-0.5rem}.mdx-content .n8n-coming-soon-logos .n8n-mark-dark,.dark .mdx-content .n8n-coming-soon-logos .n8n-mark-light{display:none}.dark .mdx-content .n8n-coming-soon-logos .n8n-mark-dark{display:block}.mdx-content .n8n-coming-soon-logos span{font-size:1.75rem;font-weight:600;opacity:0.6}.mdx-content .n8n-coming-soon-title{margin:0 0 0.35rem;font-size:1.25rem;font-weight:600;color:rgb(var(--fa-ink))}.mdx-content .n8n-coming-soon-title+*{margin-top:0}"}],"page":{"pagePath":"api-reference/conversion-events/get-one-conversion-event","slug":"/api-reference/conversion-events/get-one-conversion-event","pageMetadata":{"title":"Get one conversion event","description":"One event by its event ID.\n\n**Access:** an API key with `conversions:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `conversion-events:view` permission. Anonymous callers get 404.\n\n**Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`.","deprecated":null,"version":null,"sidebarTitle":"Get one conversion event","openapi":"/api-reference/openapi.yaml get /conversion-event/{eventId}","href":"/api-reference/conversion-events/get-one-conversion-event","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"One event by its event ID.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" an API key with \", _jsx(_components.code, {\n children: \"conversions:read\"\n }), \" — or its group master \", _jsx(_components.code, {\n children: \"ads:all\"\n }), \", or \", _jsx(_components.code, {\n children: \"admin:all\"\n }), \" — or a signed-in user holding the \", _jsx(_components.code, {\n children: \"conversion-events:view\"\n }), \" permission. Anonymous callers get 404.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limit:\"\n }), \" the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with \", _jsx(_components.code, {\n children: \"Retry-After\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get one conversion event","description":"One event by its event ID.\n\n**Access:** an API key with `conversions:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `conversion-events:view` permission. Anonymous callers get 404.\n\n**Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`.","deprecated":null,"version":null,"sidebarTitle":"Get one conversion event","openapi":"/api-reference/openapi.yaml get /conversion-event/{eventId}","href":"/api-reference/conversion-events/get-one-conversion-event","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fetchski-attract-api/f59e82e583443cfa/reader-values.js"],"openApiReferenceData":{"operation":{"operationId":"getConversionEvent","summary":"Get one conversion event","description":"One event by its event ID.\n\n**Access:** an API key with `conversions:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `conversion-events:view` permission. Anonymous callers get 404.\n\n**Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`.","tags":["Conversion Events"],"security":["6d4c5fe6-45f3-4f1f-b132-5ddb3dec09ed"],"x-required-scopes":["conversions:read"],"parameters":["1184209e-f373-4309-b18f-5c9005f6edea"],"responses":{"200":"447dd614-0702-477c-81a8-007ece34ac15","401":"b5d893ce-fb76-42c4-b6fc-1a6ef554b1b5","403":"8580d9fa-7567-45b2-8a16-20731302e75a","404":"7fcc282f-21f4-483a-9cee-f6b5cfb8cd3a","429":"4af74dce-d686-4aaa-8cf3-d5eda2356917"},"x-codeSamples":[{"lang":"typescript","label":"TypeScript","source":"import { createSiteClient } from '@fetchski/attract-cms-sdk';\n\nconst site = createSiteClient();\nconst getConversionEvent = await site.conversionEvents().getConversionEvent({ eventId: 'tenant-42:order:1234:purchase' });"},{"lang":"php","label":"Laravel","source":"use Fetchski\\AttractCmsLaravel\\Facades\\Attract;\n\n$getConversionEvent = Attract::conversionEvents()->getConversionEvent(eventId: 'tenant-42:order:1234:purchase');"}],"x-mint":{"metadata":{"title":"Get one conversion event","sidebarTitle":"Get one conversion event"}},"method":"get","type":"path","servers":["8cb43207-f628-45ca-97ad-d570b7dbc6f0"],"path":"/conversion-event/{eventId}","baseUrlOptions":["https://{host}/api/v1"],"title":"Get one conversion event","codeSamples":[{"label":"TypeScript","lang":"typescript","source":"import { createSiteClient } from '@fetchski/attract-cms-sdk';\n\nconst site = createSiteClient();\nconst getConversionEvent = await site.conversionEvents().getConversionEvent({ eventId: 'tenant-42:order:1234:purchase' });"},{"label":"Laravel","lang":"php","source":"use Fetchski\\AttractCmsLaravel\\Facades\\Attract;\n\n$getConversionEvent = Attract::conversionEvents()->getConversionEvent(eventId: 'tenant-42:order:1234:purchase');"}],"requestExampleLanguages":["bash","typescript","php"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"1184209e-f373-4309-b18f-5c9005f6edea":{"name":"eventId","in":"path","required":true,"description":"The event ID.","schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","maxLength":128,"description":"The event ID.\nOpaque, unique per site, stable. The CMS mints a UUID for events it originates; another system mints its own (e.g. `tenant-42:order:1234:purchase`). Forwarded unchanged to every ad platform as its de-duplication key.","example":"tenant-42:order:1234:purchase","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"447dd614-0702-477c-81a8-007ece34ac15":{"description":"The event.","content":{"application/json":{"schema":{"type":"object","required":["event"],"properties":{"event":{"type":"object","description":"One conversion occurrence. Fields the visitor’s consent did not allow are ABSENT, not empty. Never returned: the visitor’s IP address and user agent, outbox lease and retry bookkeeping.","required":["eventId","conversion","source","occurredAt","updatedAt","delivery","status","adjustments"],"properties":{"eventId":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","maxLength":128,"description":"Opaque, unique per site, stable. The CMS mints a UUID for events it originates; another system mints its own (e.g. `tenant-42:order:1234:purchase`). Forwarded unchanged to every ad platform as its de-duplication key.","example":"tenant-42:order:1234:purchase","isRequired":true,"uniqueKey":"event.eventId","typeLabel":"string"},"conversion":{"type":"object","required":["id","key"],"description":"The Conversion it counts for.","properties":{"id":{"type":"string","description":"The Conversion’s id.","isRequired":true,"uniqueKey":"event.conversion.id","typeLabel":"string"},"key":{"type":"string","description":"The Conversion’s key when the event was recorded.","isRequired":true,"uniqueKey":"event.conversion.key","typeLabel":"string"},"title":{"type":"string","description":"The Conversion’s name in the CMS.","uniqueKey":"event.conversion.title","typeLabel":"string"}},"isRequired":true,"uniqueKey":"event.conversion","typeLabel":"object"},"source":{"type":"string","enum":["browser","server","external"],"description":"How it was recorded: `browser` (the site’s tag), `external` (posted through the Conversion Data API), or `server` (the site’s own server; nothing records one yet).","isRequired":true,"uniqueKey":"event.source","typeLabel":"enum\u003cstring>"},"occurredAt":{"type":"string","format":"date-time","description":"When it happened.","isRequired":true,"uniqueKey":"event.occurredAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last change (delivery outcome, adjustment) — the sync order.","isRequired":true,"uniqueKey":"event.updatedAt","typeLabel":"string\u003cdate-time>"},"delivery":{"type":"object","description":"Per destination the Conversion reports to.","propertyNames":{"enum":["google-ads","ga4","gtm","meta","tiktok"]},"additionalProperties":{"type":"object","properties":{"browser":{"type":"string","enum":["sent","not-sent","n/a"],"description":"Whether the page fired it at this platform’s tag; `n/a` when the Conversion sends to this platform from the server only.","uniqueKey":"event.delivery.additionalProperties.browser","typeLabel":"enum\u003cstring>"},"server":{"type":"object","description":"Server-side delivery to this platform’s API (Google Data Manager, GA4 Measurement Protocol, Meta Conversions API, TikTok Events API).","required":["status","attempts"],"properties":{"status":{"type":"string","enum":["queued","retry","sent","failed","not-configured","expired","not-sent","no-consent","n/a"],"description":"`queued`/`retry` — owed; `sent` — delivered (`test: true` in a platform test mode); `failed` — attempts used up or a permanent error; `not-configured` — credentials, pixel, Google tag or conversion action missing; `expired` — older than the platform accepts (Google Ads 90 days, Meta and TikTok 7, Google Analytics 3); `not-sent` — retracted first, or nothing the platform can match; `no-consent` — the visitor did not allow Marketing; `n/a` — the platform has no server API here.","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.server.status","typeLabel":"enum\u003cstring>"},"attempts":{"type":"integer","minimum":0,"description":"Sends tried so far.","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.server.attempts","typeLabel":"integer"},"sentAt":{"type":"string","format":"date-time","description":"When the platform took it; absent until then.","uniqueKey":"event.delivery.additionalProperties.server.sentAt","typeLabel":"string\u003cdate-time>"},"lastAttemptAt":{"type":"string","format":"date-time","description":"The last try; absent before the first.","uniqueKey":"event.delivery.additionalProperties.server.lastAttemptAt","typeLabel":"string\u003cdate-time>"},"nextAttemptAt":{"oneOf":[{"type":"string","format":"date-time","description":"Set while `status` is `retry`; null otherwise.","uniqueKey":"event.delivery.additionalProperties.server.nextAttemptAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set while `status` is `retry`; null otherwise.","uniqueKey":"event.delivery.additionalProperties.server.nextAttemptAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.delivery.additionalProperties.server.nextAttemptAt","typeLabel":"string\u003cdate-time> | null"},"lastError":{"type":"string","maxLength":500,"description":"Why the last try failed, as the platform said.","uniqueKey":"event.delivery.additionalProperties.server.lastError","typeLabel":"string"},"detail":{"type":"string","maxLength":500,"description":"Why it wasn’t sent, for a status it ended in without trying (e.g. “The event was retracted.”).","uniqueKey":"event.delivery.additionalProperties.server.detail","typeLabel":"string"},"test":{"type":"boolean","const":true,"description":"Present (true) only when it went to the platform’s test mode.","uniqueKey":"event.delivery.additionalProperties.server.test","typeLabel":"boolean"}},"uniqueKey":"event.delivery.additionalProperties.server","typeLabel":"object"},"adjustment":{"type":"object","description":"Telling this platform about the latest adjustment, once it had already received the event. Google Ads: the event re-sent with its new value (a retraction is sent as 0 — Google still counts the conversion). Google Analytics: a `refund`, for purchases only and only to lower the value. Meta, TikTok, Google Tag Manager and browser-only rows cannot be told (`unsupported`, with what to do instead in `detail`).","required":["adjustmentId","action","status","attempts"],"properties":{"adjustmentId":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","maxLength":128,"description":"Opaque, unique per site, stable. The CMS mints a UUID for events it originates; another system mints its own (e.g. `tenant-42:order:1234:purchase`). Forwarded unchanged to every ad platform as its de-duplication key.","example":"tenant-42:order:1234:purchase","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.adjustment.adjustmentId","typeLabel":"string"},"action":{"type":"string","enum":["retract","restate"],"description":"`retract` (withdraw the conversion) or `restate` (a new value).","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.adjustment.action","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["queued","retry","sent","failed","not-configured","unsupported","not-needed"],"description":"`queued`/`retry` — owed; `sent` — delivered (`test: true` in a platform test mode); `failed` — attempts used up or a permanent error; `not-configured` — credentials or the live Google tag missing; `unsupported` — the platform cannot be told (`detail` says why and what to do instead); `not-needed` — the platform already holds this value.","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.adjustment.status","typeLabel":"enum\u003cstring>"},"attempts":{"type":"integer","minimum":0,"description":"Sends tried so far.","isRequired":true,"uniqueKey":"event.delivery.additionalProperties.adjustment.attempts","typeLabel":"integer"},"value":{"type":"number","minimum":0,"description":"The value the platform holds once it is sent.","uniqueKey":"event.delivery.additionalProperties.adjustment.value","typeLabel":"number"},"refund":{"type":"number","minimum":0,"description":"Google Analytics: the amount refunded.","uniqueKey":"event.delivery.additionalProperties.adjustment.refund","typeLabel":"number"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 code, e.g. `USD`.","uniqueKey":"event.delivery.additionalProperties.adjustment.currency","typeLabel":"string"},"sentAt":{"type":"string","format":"date-time","description":"When the platform took it; absent until then.","uniqueKey":"event.delivery.additionalProperties.adjustment.sentAt","typeLabel":"string\u003cdate-time>"},"lastAttemptAt":{"type":"string","format":"date-time","description":"The last try; absent before the first.","uniqueKey":"event.delivery.additionalProperties.adjustment.lastAttemptAt","typeLabel":"string\u003cdate-time>"},"nextAttemptAt":{"oneOf":[{"type":"string","format":"date-time","description":"Set while `status` is `retry`; null otherwise.","uniqueKey":"event.delivery.additionalProperties.adjustment.nextAttemptAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set while `status` is `retry`; null otherwise.","uniqueKey":"event.delivery.additionalProperties.adjustment.nextAttemptAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.delivery.additionalProperties.adjustment.nextAttemptAt","typeLabel":"string\u003cdate-time> | null"},"lastError":{"type":"string","maxLength":500,"description":"Why the last try failed, as the platform said.","uniqueKey":"event.delivery.additionalProperties.adjustment.lastError","typeLabel":"string"},"detail":{"type":"string","maxLength":500,"description":"Why it wasn’t sent, for a status it ended in without trying (e.g. “The event was retracted.”).","uniqueKey":"event.delivery.additionalProperties.adjustment.detail","typeLabel":"string"},"test":{"type":"boolean","const":true,"description":"Present (true) only when it went to the platform’s test mode.","uniqueKey":"event.delivery.additionalProperties.adjustment.test","typeLabel":"boolean"}},"uniqueKey":"event.delivery.additionalProperties.adjustment","typeLabel":"object"}},"uniqueKey":"event.delivery.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"event.delivery","typeLabel":"object"},"status":{"type":"string","enum":["active","retracted","adjusted"],"description":"`active`; `retracted` (withdrawn by an adjustment) or `adjusted` (its value restated).","isRequired":true,"uniqueKey":"event.status","typeLabel":"enum\u003cstring>"},"adjustments":{"type":"array","items":{"type":"object","required":["adjustmentId","action","recordedAt"],"properties":{"adjustmentId":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","maxLength":128,"description":"Opaque, unique per site, stable. The CMS mints a UUID for events it originates; another system mints its own (e.g. `tenant-42:order:1234:purchase`). Forwarded unchanged to every ad platform as its de-duplication key.","example":"tenant-42:order:1234:purchase","isRequired":true,"uniqueKey":"event.adjustments.items.[INDEX].adjustmentId","typeLabel":"string"},"action":{"type":"string","enum":["retract","restate"],"description":"`retract` (withdraw the conversion) or `restate` (a new value).","isRequired":true,"uniqueKey":"event.adjustments.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"recordedAt":{"type":"string","format":"date-time","description":"When the site stored it.","isRequired":true,"uniqueKey":"event.adjustments.items.[INDEX].recordedAt","typeLabel":"string\u003cdate-time>"},"value":{"type":"number","minimum":0,"description":"The restated value (restate only).","uniqueKey":"event.adjustments.items.[INDEX].value","typeLabel":"number"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 code of `value`.","uniqueKey":"event.adjustments.items.[INDEX].currency","typeLabel":"string"},"reason":{"type":"string","maxLength":500,"description":"Why, as the writer gave it.","uniqueKey":"event.adjustments.items.[INDEX].reason","typeLabel":"string"},"occurredAt":{"type":"string","format":"date-time","description":"When the change happened (as the writer said).","uniqueKey":"event.adjustments.items.[INDEX].occurredAt","typeLabel":"string\u003cdate-time>"},"recordedBy":{"type":"object","description":"Who wrote it: an API key (its public key ID and label) or an administrator.","required":["type","label"],"properties":{"type":{"type":"string","enum":["apiKey","user"],"description":"An API key or a signed-in person.","isRequired":true,"uniqueKey":"event.adjustments.items.[INDEX].recordedBy.type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","description":"The key’s label, or the person’s name.","isRequired":true,"uniqueKey":"event.adjustments.items.[INDEX].recordedBy.label","typeLabel":"string"},"keyId":{"type":"string","description":"An API key: its public key id.","uniqueKey":"event.adjustments.items.[INDEX].recordedBy.keyId","typeLabel":"string"},"id":{"type":"string","description":"A person: their user `_id`.","uniqueKey":"event.adjustments.items.[INDEX].recordedBy.id","typeLabel":"string"}},"uniqueKey":"event.adjustments.items.[INDEX].recordedBy","typeLabel":"object"}},"uniqueKey":"event.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Every adjustment, oldest first (empty when none).","isRequired":true,"uniqueKey":"event.adjustments","typeLabel":"object[]"},"trigger":{"type":"object","description":"What fired it.","properties":{"type":{"type":"string","enum":["form","pageView","linkClick","chat","external"],"description":"A form submitted, a page viewed, a link clicked, a chat event, or an `external` fact.","uniqueKey":"event.trigger.type","typeLabel":"enum\u003cstring>"},"ref":{"type":"string","maxLength":256,"description":"What exactly: the form’s `aposDocId` (`form`), the page path (`pageView`), the link rule that matched or `outbound:\u003chost>` / `download:\u003ctype>` (`linkClick`), the chat event (`chat`), or the producer’s reference (`external`).","uniqueKey":"event.trigger.ref","typeLabel":"string"}},"uniqueKey":"event.trigger","typeLabel":"object"},"recordedAt":{"type":"string","format":"date-time","description":"When the site stored it.","uniqueKey":"event.recordedAt","typeLabel":"string\u003cdate-time>"},"page":{"type":"object","description":"The page it happened on.","properties":{"url":{"type":"string","format":"uri","description":"Analytics or Marketing only.","uniqueKey":"event.page.url","typeLabel":"string\u003curi>"},"path":{"type":"string","description":"Its path.","uniqueKey":"event.page.path","typeLabel":"string"},"referrer":{"type":"string","description":"Origin only.","uniqueKey":"event.page.referrer","typeLabel":"string"}},"uniqueKey":"event.page","typeLabel":"object"},"visitorId":{"type":"string","description":"Analytics or Marketing only.","uniqueKey":"event.visitorId","typeLabel":"string"},"attribution":{"type":"object","description":"The attribution snapshot the event copied when it happened — independent of the visitor record’s later changes or expiry.","required":["adPlatforms","campaign"],"properties":{"adPlatforms":{"type":"array","items":{"type":"string","uniqueKey":"event.attribution.adPlatforms.items.[INDEX]","typeLabel":"string"},"description":"The ad platforms whose click ids the visits carried (empty when none).","isRequired":true,"uniqueKey":"event.attribution.adPlatforms","typeLabel":"string[]"},"campaign":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.campaign.additionalProperties","typeLabel":"string"},"description":"The campaign parameters in force (`utm_*`, …); empty when none.","isRequired":true,"uniqueKey":"event.attribution.campaign","typeLabel":"object"},"firstTouch":{"oneOf":[{"type":"object","description":"The visitor’s first visit on record; null when unknown.","properties":{"at":{"type":"string","format":"date-time","description":"When the page view happened.","uniqueKey":"event.attribution.firstTouch.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"path":{"type":"string","example":"/pricing","description":"The page’s path.","uniqueKey":"event.attribution.firstTouch.oneOf.0.path","typeLabel":"string"},"landingUrl":{"type":"string","format":"uri","description":"The full landing URL. Without Marketing consent its identifier parameters are removed.","uniqueKey":"event.attribution.firstTouch.oneOf.0.landingUrl","typeLabel":"string\u003curi>"},"referrerOrigin":{"oneOf":[{"type":"string","description":"Where the visitor came from; null for a direct visit.","example":"https://www.google.com","uniqueKey":"event.attribution.firstTouch.oneOf.0.referrerOrigin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the visitor came from; null for a direct visit.","example":"https://www.google.com","uniqueKey":"event.attribution.firstTouch.oneOf.0.referrerOrigin.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.attribution.firstTouch.oneOf.0.referrerOrigin","typeLabel":"string | null"},"adPlatforms":{"type":"array","items":{"type":"string","enum":["google","meta","tiktok","other"],"uniqueKey":"event.attribution.firstTouch.oneOf.0.adPlatforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Platforms whose ad click ID the URL carried — kept for every visitor, consent or not.","uniqueKey":"event.attribution.firstTouch.oneOf.0.adPlatforms","typeLabel":"enum\u003cstring>[]"},"campaign":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.firstTouch.oneOf.0.campaign.additionalProperties","typeLabel":"string"},"description":"UTM and campaign parameters (`utm_*`, `gad_source`, `gad_campaignid`, `srsltid`).","example":{"utm_source":"google","utm_campaign":"spring-sale"},"uniqueKey":"event.attribution.firstTouch.oneOf.0.campaign","typeLabel":"object"},"clickIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.firstTouch.oneOf.0.clickIds.additionalProperties","typeLabel":"string"},"description":"Ad click IDs (`gclid`, `gbraid`, `wbraid`, `fbclid`, `ttclid`). Marketing only.","example":{"gclid":"Cj0KCQjw…"},"uniqueKey":"event.attribution.firstTouch.oneOf.0.clickIds","typeLabel":"object"},"linker":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.firstTouch.oneOf.0.linker.additionalProperties","typeLabel":"string"},"description":"Google’s cross-domain linker value (`_gl`). Marketing only.","uniqueKey":"event.attribution.firstTouch.oneOf.0.linker","typeLabel":"object"}},"uniqueKey":"event.attribution.firstTouch.oneOf.0","typeLabel":"object"},{"type":"null","description":"The visitor’s first visit on record; null when unknown.","uniqueKey":"event.attribution.firstTouch.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.attribution.firstTouch","typeLabel":"object | null"},"lastTouch":{"oneOf":[{"type":"object","description":"Their last visit with an ad click or campaign parameters; null when none.","properties":{"at":{"type":"string","format":"date-time","description":"When the page view happened.","uniqueKey":"event.attribution.lastTouch.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"path":{"type":"string","example":"/pricing","description":"The page’s path.","uniqueKey":"event.attribution.lastTouch.oneOf.0.path","typeLabel":"string"},"landingUrl":{"type":"string","format":"uri","description":"The full landing URL. Without Marketing consent its identifier parameters are removed.","uniqueKey":"event.attribution.lastTouch.oneOf.0.landingUrl","typeLabel":"string\u003curi>"},"referrerOrigin":{"oneOf":[{"type":"string","description":"Where the visitor came from; null for a direct visit.","example":"https://www.google.com","uniqueKey":"event.attribution.lastTouch.oneOf.0.referrerOrigin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where the visitor came from; null for a direct visit.","example":"https://www.google.com","uniqueKey":"event.attribution.lastTouch.oneOf.0.referrerOrigin.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.attribution.lastTouch.oneOf.0.referrerOrigin","typeLabel":"string | null"},"adPlatforms":{"type":"array","items":{"type":"string","enum":["google","meta","tiktok","other"],"uniqueKey":"event.attribution.lastTouch.oneOf.0.adPlatforms.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Platforms whose ad click ID the URL carried — kept for every visitor, consent or not.","uniqueKey":"event.attribution.lastTouch.oneOf.0.adPlatforms","typeLabel":"enum\u003cstring>[]"},"campaign":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.lastTouch.oneOf.0.campaign.additionalProperties","typeLabel":"string"},"description":"UTM and campaign parameters (`utm_*`, `gad_source`, `gad_campaignid`, `srsltid`).","example":{"utm_source":"google","utm_campaign":"spring-sale"},"uniqueKey":"event.attribution.lastTouch.oneOf.0.campaign","typeLabel":"object"},"clickIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.lastTouch.oneOf.0.clickIds.additionalProperties","typeLabel":"string"},"description":"Ad click IDs (`gclid`, `gbraid`, `wbraid`, `fbclid`, `ttclid`). Marketing only.","example":{"gclid":"Cj0KCQjw…"},"uniqueKey":"event.attribution.lastTouch.oneOf.0.clickIds","typeLabel":"object"},"linker":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.lastTouch.oneOf.0.linker.additionalProperties","typeLabel":"string"},"description":"Google’s cross-domain linker value (`_gl`). Marketing only.","uniqueKey":"event.attribution.lastTouch.oneOf.0.linker","typeLabel":"object"}},"uniqueKey":"event.attribution.lastTouch.oneOf.0","typeLabel":"object"},{"type":"null","description":"Their last visit with an ad click or campaign parameters; null when none.","uniqueKey":"event.attribution.lastTouch.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.attribution.lastTouch","typeLabel":"object | null"},"clickIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.clickIds.additionalProperties","typeLabel":"string"},"description":"Marketing only.","uniqueKey":"event.attribution.clickIds","typeLabel":"object"},"browserIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"event.attribution.browserIds.additionalProperties","typeLabel":"string"},"description":"Ad-platform browser IDs (`_gcl_au` — the cross-site key — `_gcl_aw`, `_gcl_gb`, `_gcl_gs`, `_gcl_dc`, `_ga`, `_fbp`, `_fbc`, `_ttp`). Marketing only.","example":{"_gcl_au":"1.1.1234567890.1790000000","_fbp":"fb.1.1790000000000.123456789"},"uniqueKey":"event.attribution.browserIds","typeLabel":"object"},"gaSessions":{"type":"object","additionalProperties":{"type":"string","pattern":"^\\d{6,20}$","uniqueKey":"event.attribution.gaSessions.additionalProperties","typeLabel":"string"},"description":"The visitor’s Google Analytics session per data stream when it happened (from the `_ga_\u003ccontainer>` cookies), keyed by the measurement ID without its `G-`. The GA4 server sender joins the event to that session. Marketing only.","example":{"AB12CD34EF":"1790000000"},"uniqueKey":"event.attribution.gaSessions","typeLabel":"object"},"provenance":{"type":"object","additionalProperties":{"type":"string","enum":["ourRecord","url","platformCookie","producer"],"uniqueKey":"event.attribution.provenance.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"Where each identifier came from: the visitor’s attribution record, the page URL, the platform’s own cookie, or the system that posted an external fact.","uniqueKey":"event.attribution.provenance","typeLabel":"object"}},"uniqueKey":"event.attribution","typeLabel":"object"},"consent":{"type":"object","description":"The consent in force when the event happened. For an external fact (`origin: producer`) the posting system’s flags are recorded as `adUserData` / `adPersonalization` / `gpc` (limited data use).","required":["categories","mode","gpc"],"properties":{"categories":{"type":"object","description":"What the visitor allowed.","properties":{"analytics":{"type":"boolean","description":"Analytics cookies and measurement.","uniqueKey":"event.consent.categories.analytics","typeLabel":"boolean"},"marketing":{"type":"boolean","description":"Marketing: ad platforms and their identifiers.","uniqueKey":"event.consent.categories.marketing","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"event.consent.categories","typeLabel":"object"},"mode":{"type":"string","enum":["lenient","strict"],"description":"The rule that applied to the visitor: `lenient` (a notice-only region: non-essential ran unless they declined) or `strict` (an opt-in region: nothing non-essential until they agreed).","isRequired":true,"uniqueKey":"event.consent.mode","typeLabel":"enum\u003cstring>"},"gpc":{"type":"boolean","description":"Global Privacy Control, or the producer’s limited-data-use flag.","isRequired":true,"uniqueKey":"event.consent.gpc","typeLabel":"boolean"},"country":{"oneOf":[{"type":"string","pattern":"^[A-Z]{2}$","description":"The visitor’s two-letter country, when known; null otherwise.","uniqueKey":"event.consent.country.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[A-Z]{2}$","description":"The visitor’s two-letter country, when known; null otherwise.","uniqueKey":"event.consent.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.consent.country","typeLabel":"string | null"},"policyVersion":{"oneOf":[{"type":"integer","description":"The consent policy version the visitor answered; null when none.","uniqueKey":"event.consent.policyVersion.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The consent policy version the visitor answered; null when none.","uniqueKey":"event.consent.policyVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.consent.policyVersion","typeLabel":"integer | null"},"adUserData":{"type":"boolean","description":"An external fact: the producer allowed sending user data to ad platforms.","uniqueKey":"event.consent.adUserData","typeLabel":"boolean"},"adPersonalization":{"type":"boolean","description":"An external fact: the producer allowed ad personalization.","uniqueKey":"event.consent.adPersonalization","typeLabel":"boolean"},"origin":{"type":"string","const":"producer","description":"Present (`producer`) when the consent came with an external fact.","uniqueKey":"event.consent.origin","typeLabel":"string"}},"uniqueKey":"event.consent","typeLabel":"object"},"value":{"type":"number","minimum":0,"description":"Its value, when the Conversion has one.","uniqueKey":"event.value","typeLabel":"number"},"adjustedValue":{"type":"number","minimum":0,"description":"The latest restated value.","uniqueKey":"event.adjustedValue","typeLabel":"number"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 code of `value`, e.g. `USD`.","uniqueKey":"event.currency","typeLabel":"string"},"userData":{"type":"object","description":"Hashed contact details. Email: trimmed + lower-cased; `emailGoogleSha256` only for a Gmail address with dots (Google drops them). Phone: E.164 — `phoneSha256` with the \"+\", `phoneDigitsSha256` without (Meta’s form).","properties":{"emailSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 digest.","uniqueKey":"event.userData.emailSha256","typeLabel":"string"},"emailGoogleSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 digest.","uniqueKey":"event.userData.emailGoogleSha256","typeLabel":"string"},"phoneSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 digest.","uniqueKey":"event.userData.phoneSha256","typeLabel":"string"},"phoneDigitsSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 digest.","uniqueKey":"event.userData.phoneDigitsSha256","typeLabel":"string"}},"uniqueKey":"event.userData","typeLabel":"object"},"submissionId":{"type":"string","description":"The form submission a form conversion came from.","uniqueKey":"event.submissionId","typeLabel":"string"},"producer":{"type":"object","description":"The system that posted an external fact.","required":["system","contentHash","recordedBy"],"properties":{"system":{"type":"string","example":"reservation","description":"The system’s name, as it posted it (lowercase, `a-z0-9._-`, at most 64).","isRequired":true,"uniqueKey":"event.producer.system","typeLabel":"string"},"contentHash":{"type":"string","description":"Fingerprint of the posted fact (idempotency).","isRequired":true,"uniqueKey":"event.producer.contentHash","typeLabel":"string"},"recordedBy":{"type":"object","description":"Who wrote it: an API key (its public key ID and label) or an administrator.","required":["type","label"],"properties":{"type":{"type":"string","enum":["apiKey","user"],"description":"An API key or a signed-in person.","isRequired":true,"uniqueKey":"event.producer.recordedBy.type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","description":"The key’s label, or the person’s name.","isRequired":true,"uniqueKey":"event.producer.recordedBy.label","typeLabel":"string"},"keyId":{"type":"string","description":"An API key: its public key id.","uniqueKey":"event.producer.recordedBy.keyId","typeLabel":"string"},"id":{"type":"string","description":"A person: their user `_id`.","uniqueKey":"event.producer.recordedBy.id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"event.producer.recordedBy","typeLabel":"object"},"ref":{"type":"string","example":"booking-1234","description":"Its own reference for the fact (at most 256 characters), when it gave one.","uniqueKey":"event.producer.ref","typeLabel":"string"}},"uniqueKey":"event.producer","typeLabel":"object"},"join":{"type":"object","description":"How an external fact was joined to a visitor (`by: null` — no match).","properties":{"by":{"oneOf":[{"description":"The identifier that matched, or null for none.","type":"string","enum":["visitorId","token","gclAu","gclid","gbraid","wbraid","fbclid","ttclid","emailSha256","phoneSha256",null],"uniqueKey":"event.join.by.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The identifier that matched, or null for none.","type":"null","enum":["visitorId","token","gclAu","gclid","gbraid","wbraid","fbclid","ttclid","emailSha256","phoneSha256",null],"uniqueKey":"event.join.by.oneOf.1","typeLabel":"null"}],"uniqueKey":"event.join.by","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"event.join","typeLabel":"object"}},"example":{"eventId":"b8f2c1de-4f5a-4c1e-9a53-0d6f2b7c1e9a","conversion":{"id":"ckq1w2e3r4t5y6u7i8o9p0","key":"quote-request","title":"Quote request"},"trigger":{"type":"form","ref":"ckformid123"},"source":"browser","occurredAt":"2026-09-21T15:04:05.000Z","recordedAt":"2026-09-21T15:04:05.412Z","updatedAt":"2026-09-21T15:04:07.020Z","page":{"url":"https://example.com/contact?gclid=Cj0KCQjw","path":"/contact","referrer":"https://www.google.com"},"visitorId":"0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c","attribution":{"firstTouch":{"at":"2026-09-20T09:12:00.000Z","path":"/","landingUrl":"https://example.com/?gclid=Cj0KCQjw","referrerOrigin":"https://www.google.com","adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"}},"adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"},"browserIds":{"_gcl_au":"1.1.1234567890.1790000000"},"provenance":{"gclid":"ourRecord","_gcl_au":"platformCookie"}},"consent":{"categories":{"analytics":true,"marketing":true},"mode":"lenient","country":"US","gpc":false,"policyVersion":7},"value":50,"currency":"USD","userData":{"emailSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneDigitsSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"},"submissionId":"ck9submission1","delivery":{"google-ads":{"browser":"sent","server":{"status":"sent","attempts":1,"sentAt":"2026-09-21T15:04:07.001Z","lastAttemptAt":"2026-09-21T15:04:07.001Z"}},"ga4":{"browser":"sent","server":{"status":"n/a","attempts":0}}},"status":"active","adjustments":[]},"isRequired":true,"uniqueKey":"event","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"event":{"eventId":"b8f2c1de-4f5a-4c1e-9a53-0d6f2b7c1e9a","conversion":{"id":"ckq1w2e3r4t5y6u7i8o9p0","key":"quote-request","title":"Quote request"},"trigger":{"type":"form","ref":"ckformid123"},"source":"browser","occurredAt":"2026-09-21T15:04:05.000Z","recordedAt":"2026-09-21T15:04:05.412Z","updatedAt":"2026-09-21T15:04:07.020Z","page":{"url":"https://example.com/contact?gclid=Cj0KCQjw","path":"/contact","referrer":"https://www.google.com"},"visitorId":"0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c","attribution":{"firstTouch":{"at":"2026-09-20T09:12:00.000Z","path":"/","landingUrl":"https://example.com/?gclid=Cj0KCQjw","referrerOrigin":"https://www.google.com","adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"}},"adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"},"browserIds":{"_gcl_au":"1.1.1234567890.1790000000"},"provenance":{"gclid":"ourRecord","_gcl_au":"platformCookie"}},"consent":{"categories":{"analytics":true,"marketing":true},"mode":"lenient","country":"US","gpc":false,"policyVersion":7},"value":50,"currency":"USD","userData":{"emailSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneDigitsSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"},"submissionId":"ck9submission1","delivery":{"google-ads":{"browser":"sent","server":{"status":"sent","attempts":1,"sentAt":"2026-09-21T15:04:07.001Z","lastAttemptAt":"2026-09-21T15:04:07.001Z"}},"ga4":{"browser":"sent","server":{"status":"n/a","attempts":0}}},"status":"active","adjustments":[]}},"examples":{"Example":{"title":"Example","value":{"event":{"eventId":"b8f2c1de-4f5a-4c1e-9a53-0d6f2b7c1e9a","conversion":{"id":"ckq1w2e3r4t5y6u7i8o9p0","key":"quote-request","title":"Quote request"},"trigger":{"type":"form","ref":"ckformid123"},"source":"browser","occurredAt":"2026-09-21T15:04:05.000Z","recordedAt":"2026-09-21T15:04:05.412Z","updatedAt":"2026-09-21T15:04:07.020Z","page":{"url":"https://example.com/contact?gclid=Cj0KCQjw","path":"/contact","referrer":"https://www.google.com"},"visitorId":"0b8e6a4c-8d2f-4b6e-9a1c-3f5d7e9b1a2c","attribution":{"firstTouch":{"at":"2026-09-20T09:12:00.000Z","path":"/","landingUrl":"https://example.com/?gclid=Cj0KCQjw","referrerOrigin":"https://www.google.com","adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"}},"adPlatforms":["google"],"campaign":{"utm_source":"google","utm_campaign":"spring-sale"},"clickIds":{"gclid":"Cj0KCQjw"},"browserIds":{"_gcl_au":"1.1.1234567890.1790000000"},"provenance":{"gclid":"ourRecord","_gcl_au":"platformCookie"}},"consent":{"categories":{"analytics":true,"marketing":true},"mode":"lenient","country":"US","gpc":false,"policyVersion":7},"value":50,"currency":"USD","userData":{"emailSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514","phoneDigitsSha256":"b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"},"submissionId":"ck9submission1","delivery":{"google-ads":{"browser":"sent","server":{"status":"sent","attempts":1,"sentAt":"2026-09-21T15:04:07.001Z","lastAttemptAt":"2026-09-21T15:04:07.001Z"}},"ga4":{"browser":"sent","server":{"status":"n/a","attempts":0}}},"status":"active","adjustments":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"b5d893ce-fb76-42c4-b6fc-1a6ef554b1b5":{"description":"The API key is missing, malformed, unknown, disabled, expired or archived (`invalid`), or a request that must be signed — by the route, or by the key’s own signing mode — has a missing, stale or wrong signature (an upload signs its SHA-256, declared in `X-Fetchski-Content-SHA256`, in the body’s place) (`unauthorized`).","content":{"application/json":{"schema":{"type":"object","description":"Every error. `name` → HTTP status: `invalid` 400, `invalid`/`unauthorized` 401, `forbidden` 403, `notfound` 404, `conflict` 409, `tooManyRequests` 429.","required":["name","message"],"properties":{"name":{"type":"string","enum":["invalid","unauthorized","forbidden","notfound","conflict","tooManyRequests","error"],"isRequired":true,"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","example":"invalid","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"integer","example":400,"uniqueKey":"data.errors.items.[INDEX].code","typeLabel":"integer"},"path":{"type":"string","description":"The query parameter or body field (dotted) the problem is in.","example":"match.emailSha256","uniqueKey":"data.errors.items.[INDEX].path","typeLabel":"string"},"data":{"type":"object","uniqueKey":"data.errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"data.errors.items.[INDEX]","typeLabel":"object"},"description":"Present on 400.","uniqueKey":"data.errors","typeLabel":"object[]"},"retryAfter":{"type":"integer","description":"Present on 429.","uniqueKey":"data.retryAfter","typeLabel":"integer"},"eventId":{"type":"string","description":"Present on 409.","uniqueKey":"data.eventId","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"unauthorized","message":"X-Fetchski-Signature does not match this request.","data":{}},"examples":{"Example":{"title":"Example","value":{"name":"unauthorized","message":"X-Fetchski-Signature does not match this request.","data":{}}}},"exampleType":"examples"}},"exampleType":"examples"},"8580d9fa-7567-45b2-8a16-20731302e75a":{"description":"The API key lacks the scope this route needs (the message names it), or the key is used from an address outside its allowlist.","content":{"application/json":{"schema":{"type":"object","description":"Every error. `name` → HTTP status: `invalid` 400, `invalid`/`unauthorized` 401, `forbidden` 403, `notfound` 404, `conflict` 409, `tooManyRequests` 429.","required":["name","message"],"properties":{"name":{"type":"string","enum":["invalid","unauthorized","forbidden","notfound","conflict","tooManyRequests","error"],"isRequired":true,"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","example":"invalid","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"integer","example":400,"uniqueKey":"data.errors.items.[INDEX].code","typeLabel":"integer"},"path":{"type":"string","description":"The query parameter or body field (dotted) the problem is in.","example":"match.emailSha256","uniqueKey":"data.errors.items.[INDEX].path","typeLabel":"string"},"data":{"type":"object","uniqueKey":"data.errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"data.errors.items.[INDEX]","typeLabel":"object"},"description":"Present on 400.","uniqueKey":"data.errors","typeLabel":"object[]"},"retryAfter":{"type":"integer","description":"Present on 429.","uniqueKey":"data.retryAfter","typeLabel":"integer"},"eventId":{"type":"string","description":"Present on 409.","uniqueKey":"data.eventId","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"forbidden","message":"This API key lacks the required scope: conversions:read.","data":{}},"examples":{"Example":{"title":"Example","value":{"name":"forbidden","message":"This API key lacks the required scope: conversions:read.","data":{}}}},"exampleType":"examples"}},"exampleType":"examples"},"7fcc282f-21f4-483a-9cee-f6b5cfb8cd3a":{"description":"Nothing with this identifier — or the caller may not use the Data API at all (anonymous visitors and non-admin sessions get 404 so the API is not advertised). A write while conversion tracking is switched off also answers 404.","content":{"application/json":{"schema":{"type":"object","description":"Every error. `name` → HTTP status: `invalid` 400, `invalid`/`unauthorized` 401, `forbidden` 403, `notfound` 404, `conflict` 409, `tooManyRequests` 429.","required":["name","message"],"properties":{"name":{"type":"string","enum":["invalid","unauthorized","forbidden","notfound","conflict","tooManyRequests","error"],"isRequired":true,"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","example":"invalid","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"integer","example":400,"uniqueKey":"data.errors.items.[INDEX].code","typeLabel":"integer"},"path":{"type":"string","description":"The query parameter or body field (dotted) the problem is in.","example":"match.emailSha256","uniqueKey":"data.errors.items.[INDEX].path","typeLabel":"string"},"data":{"type":"object","uniqueKey":"data.errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"data.errors.items.[INDEX]","typeLabel":"object"},"description":"Present on 400.","uniqueKey":"data.errors","typeLabel":"object[]"},"retryAfter":{"type":"integer","description":"Present on 429.","uniqueKey":"data.retryAfter","typeLabel":"integer"},"eventId":{"type":"string","description":"Present on 409.","uniqueKey":"data.eventId","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"notfound","message":"No event with this ID.","data":{}},"examples":{"Example":{"title":"Example","value":{"name":"notfound","message":"No event with this ID.","data":{}}}},"exampleType":"examples"}},"exampleType":"examples"},"4af74dce-d686-4aaa-8cf3-d5eda2356917":{"description":"The key used up its reads- or writes-per-minute limit (set per key; defaults 600 / 120). Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds until the budget resets.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","description":"Every error. `name` → HTTP status: `invalid` 400, `invalid`/`unauthorized` 401, `forbidden` 403, `notfound` 404, `conflict` 409, `tooManyRequests` 429.","required":["name","message"],"properties":{"name":{"type":"string","enum":["invalid","unauthorized","forbidden","notfound","conflict","tooManyRequests","error"],"isRequired":true,"uniqueKey":"name","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","required":["name","message"],"properties":{"name":{"type":"string","example":"invalid","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"integer","example":400,"uniqueKey":"data.errors.items.[INDEX].code","typeLabel":"integer"},"path":{"type":"string","description":"The query parameter or body field (dotted) the problem is in.","example":"match.emailSha256","uniqueKey":"data.errors.items.[INDEX].path","typeLabel":"string"},"data":{"type":"object","uniqueKey":"data.errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"data.errors.items.[INDEX]","typeLabel":"object"},"description":"Present on 400.","uniqueKey":"data.errors","typeLabel":"object[]"},"retryAfter":{"type":"integer","description":"Present on 429.","uniqueKey":"data.retryAfter","typeLabel":"integer"},"eventId":{"type":"string","description":"Present on 409.","uniqueKey":"data.eventId","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"tooManyRequests","message":"This API key’s rate limit is used up for this minute.","data":{"retryAfter":12}},"examples":{"Example":{"title":"Example","value":{"name":"tooManyRequests","message":"This API key’s rate limit is used up for this minute.","data":{"retryAfter":12}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6d4c5fe6-45f3-4f1f-b132-5ddb3dec09ed":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Paste your API key as the CMS showed it: `fsk_\u003csite>_\u003ckey id>_\u003csecret>` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public.","scopes":["conversions:read"],"schemeName":"ApiKeyAuth"}}},"servers":{"8cb43207-f628-45ca-97ad-d570b7dbc6f0":{"url":"https://{host}/api/v1","description":"Your site: set `host` to its host name.","variables":{"host":{"default":"acme.example"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Paste your API key as the CMS showed it: `fsk_\u003csite>_\u003ckey id>_\u003csecret>` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public.","scopes":["conversions:read"],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"Paste your API key as the CMS showed it: `fsk_\u003csite>_\u003ckey id>_\u003csecret>` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"fetchski-attract-api","siteName":"Fetchski Attract Docs","title":"Get one conversion event - Fetchski Attract Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T10:15:37.035Z","originalFileLocation":"api-reference/conversion-events/get-one-conversion-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One event by its event ID. Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404. Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fetchski Attract Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get one conversion event - Fetchski Attract Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"One event by its event ID. Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404. Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fetchski Attract Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fetchski-attract-api.mintlify.site/_mintlify/api/og/v2?division=Conversion+Events\u0026amp;title=Get+one+conversion+event\u0026amp;description=One+event+by+its+event+ID.%0A%0A**Access%3A**+an+API+key+with+%60conversions%3Aread%60+%E2%80%94+or+its+group+master+%60ads%3Aall%60%2C+or+%60admin%3Aall%60+%E2%80%94+or+a+signed-in+user+holding+the+%60co\u0026amp;theme=0e1cff4688ef26ca6a5fb667\u0026amp;signature=d27227dc0ad8638e409ff8b82d04789b99969532a01c40845454e536d99b86b4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get one conversion event - Fetchski Attract Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One event by its event ID. Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404. Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fetchski-attract-api.mintlify.site/_mintlify/api/og/v2?division=Conversion+Events\u0026amp;title=Get+one+conversion+event\u0026amp;description=One+event+by+its+event+ID.%0A%0A**Access%3A**+an+API+key+with+%60conversions%3Aread%60+%E2%80%94+or+its+group+master+%60ads%3Aall%60%2C+or+%60admin%3Aall%60+%E2%80%94+or+a+signed-in+user+holding+the+%60co\u0026amp;theme=0e1cff4688ef26ca6a5fb667\u0026amp;signature=d27227dc0ad8638e409ff8b82d04789b99969532a01c40845454e536d99b86b4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fetchski-attract-api/70pYtWMpcnXR0SYV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fetchski Attract Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16a34a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/conversion-events/get-one-conversion-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fetchski-attract.com/#organization\",\"name\":\"Fetchski Attract Docs\",\"url\":\"https://docs.fetchski-attract.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fetchski-attract-api/mn9qfQRsqaASh7UE/logo/light.svg?fit=max\u0026auto=format\u0026n=mn9qfQRsqaASh7UE\u0026q=85\u0026s=66db13e248b70a44a5ff5f6990d4cb63\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fetchski-attract.com#website\",\"name\":\"Fetchski Attract Docs\",\"url\":\"https://docs.fetchski-attract.com\",\"publisher\":{\"@id\":\"https://docs.fetchski-attract.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event#webpage\",\"url\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event\",\"name\":\"Get one conversion event\",\"description\":\"One event by its event ID. Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404. Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.\",\"dateModified\":\"2026-11-12T10:15:37.035Z\",\"isPartOf\":{\"@id\":\"https://docs.fetchski-attract.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ads \u0026 Conversions\",\"item\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/list-conversion-events-incremental-sync\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Conversion Events\",\"item\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/list-conversion-events-incremental-sync\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get one conversion event\",\"item\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event#apireference\",\"headline\":\"Get one conversion event\",\"name\":\"Get one conversion event\",\"description\":\"One event by its event ID. Access: an API key with conversions:read — or its group master ads:all, or admin:all — or a signed-in user holding the conversion-events:view permission. Anonymous callers get 404. Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.\",\"url\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fetchski-attract.com/api-reference/conversion-events/get-one-conversion-event#webpage\"},\"dateModified\":\"2026-11-12T10:15:37.035Z\",\"publisher\":{\"@id\":\"https://docs.fetchski-attract.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fetchski-attract.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fetchski Attract Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Fetchski Attract Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/conversion-events/get-one-conversion-event.md","siteName":"Fetchski Attract Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"FetchskiAI","icon":"sparkles","pages":[{"title":"FetchskiAI","href":"/fetchskiai/overview"}]},{"tab":"Recipes","icon":"book-open","pages":[{"title":"Recipes","href":"/recipes/laravel-ai-translate-your-site"}]},{"tab":"TypeScript","icon":"js","pages":[{"title":"TypeScript","href":"/typescript/overview"}]},{"tab":"Laravel","icon":"laravel","pages":[{"title":"Laravel","href":"/laravel/overview"}]},{"tab":"AdonisJS","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fetchski-attract-api/logo/adonisjs.svg","pages":[{"title":"AdonisJS","href":"/adonisjs/overview"}]},{"tab":"API reference","icon":"code","groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"Quickstart","icon":"rocket","href":"/quickstart"},{"title":"Authentication","icon":"key","href":"/authentication"},{"title":"Signing requests","icon":"signature","href":"/signing"},{"title":"Agent Skills","icon":"robot","href":"/agent-skills"},{"title":"Call any method from the terminal","sidebarTitle":"Call from the terminal","icon":"terminal","href":"/call-command"}]},{"group":"How the API works","icon":"gears","pages":[{"title":"Required scopes","icon":"key","href":"/scopes"},{"title":"Lists and paging","icon":"list-ol","href":"/paging"},{"title":"Find a document's id","sidebarTitle":"Find an id","icon":"fingerprint","href":"/find-an-id"},{"title":"Drafts and locales","icon":"language","href":"/drafts-and-locales"},{"title":"Errors and rate limits","icon":"triangle-exclamation","href":"/errors"}]},{"group":"Pages \u0026 Site","icon":"sitemap","pages":[{"group":"Pages","icon":"file-lines","pages":[{"title":"List pages","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/page","href":"/api-reference/pages/list-pages"},{"title":"Get a page","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/page/{_id}","href":"/api-reference/pages/get-a-page"},{"title":"Create a page","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page","href":"/api-reference/pages/create-a-page"},{"title":"Update a page","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/page/{_id}","href":"/api-reference/pages/update-a-page"},{"title":"Replace a page","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/page/{_id}","href":"/api-reference/pages/replace-a-page"},{"title":"Delete a page","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/page/{_id}","href":"/api-reference/pages/delete-a-page"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a page","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/publish","href":"/api-reference/pages/publish-a-page"},{"title":"Unpublish a page","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/unpublish","href":"/api-reference/pages/unpublish-a-page"},{"title":"Submit a page for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/submit","href":"/api-reference/pages/submit-a-page-for-review"},{"title":"Dismiss a page’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/dismiss-submission","href":"/api-reference/pages/dismiss-a-page’s-review-submission"},{"title":"Discard a page’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/revert-draft-to-published","href":"/api-reference/pages/discard-a-page’s-draft-changes"},{"title":"Restore a page’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/revert-published-to-previous","href":"/api-reference/pages/restore-a-page’s-previous-publish"},{"title":"Share a page’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/share","href":"/api-reference/pages/share-a-page’s-draft"},{"title":"Copy a page to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/{_id}/localize","href":"/api-reference/pages/copy-a-page-to-another-locale"},{"title":"List a page’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/page/{_id}/locales","href":"/api-reference/pages/list-a-page’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish pages","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/publish","href":"/api-reference/pages/publish-pages"},{"title":"Archive pages","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/archive","href":"/api-reference/pages/archive-pages"},{"title":"Restore pages","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/restore","href":"/api-reference/pages/restore-pages"},{"title":"Copy pages to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/page/localize","href":"/api-reference/pages/copy-pages-to-another-locale"}]}]},{"group":"Global Content","icon":"globe","pages":[{"title":"List global documents","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/global","href":"/api-reference/global-content/list-global-documents"},{"title":"Get a global document","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/global/{_id}","href":"/api-reference/global-content/get-a-global-document"},{"title":"Create a global document","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global","href":"/api-reference/global-content/create-a-global-document"},{"title":"Update a global document","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/global/{_id}","href":"/api-reference/global-content/update-a-global-document"},{"title":"Replace a global document","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/global/{_id}","href":"/api-reference/global-content/replace-a-global-document"},{"title":"Delete a global document","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/global/{_id}","href":"/api-reference/global-content/delete-a-global-document"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a global document","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/publish","href":"/api-reference/global-content/publish-a-global-document"},{"title":"Unpublish a global document","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/unpublish","href":"/api-reference/global-content/unpublish-a-global-document"},{"title":"Submit a global document for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/submit","href":"/api-reference/global-content/submit-a-global-document-for-review"},{"title":"Dismiss a global document’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/dismiss-submission","href":"/api-reference/global-content/dismiss-a-global-document’s-review-submission"},{"title":"Discard a global document’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/revert-draft-to-published","href":"/api-reference/global-content/discard-a-global-document’s-draft-changes"},{"title":"Restore a global document’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/revert-published-to-previous","href":"/api-reference/global-content/restore-a-global-document’s-previous-publish"},{"title":"Share a global document’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/share","href":"/api-reference/global-content/share-a-global-document’s-draft"},{"title":"Copy a global document to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/{_id}/localize","href":"/api-reference/global-content/copy-a-global-document-to-another-locale"},{"title":"List a global document’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/global/{_id}/locales","href":"/api-reference/global-content/list-a-global-document’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish global documents","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/publish","href":"/api-reference/global-content/publish-global-documents"},{"title":"Archive global documents","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/archive","href":"/api-reference/global-content/archive-global-documents"},{"title":"Restore global documents","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/restore","href":"/api-reference/global-content/restore-global-documents"},{"title":"Copy global documents to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/global/localize","href":"/api-reference/global-content/copy-global-documents-to-another-locale"}]}]},{"group":"Redirects","icon":"arrow-right-arrow-left","pages":[{"title":"List redirects","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/redirect","href":"/api-reference/redirects/list-redirects"},{"title":"Get a redirect","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/redirect/{_id}","href":"/api-reference/redirects/get-a-redirect"},{"title":"Create a redirect","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/redirect","href":"/api-reference/redirects/create-a-redirect"},{"title":"Update a redirect","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/redirect/{_id}","href":"/api-reference/redirects/update-a-redirect"},{"title":"Replace a redirect","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/redirect/{_id}","href":"/api-reference/redirects/replace-a-redirect"},{"title":"Delete a redirect","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/redirect/{_id}","href":"/api-reference/redirects/delete-a-redirect"},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Archive redirects","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/redirect/archive","href":"/api-reference/redirects/archive-redirects"},{"title":"Restore redirects","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/redirect/restore","href":"/api-reference/redirects/restore-redirects"}]}]},{"group":"Internationalization","icon":"language","pages":[{"title":"List the site’s languages","deprecated":null,"version":null,"sidebarTitle":"List the site’s languages","openapi":"/api-reference/openapi.yaml get /@apostrophecms/i18n/locales","href":"/api-reference/internationalization/list-the-site’s-languages"},{"title":"Get locale path and manage clipboard","deprecated":null,"version":null,"sidebarTitle":"Get locale path and manage clipboard","openapi":"/api-reference/openapi.yaml post /@apostrophecms/i18n/locale","href":"/api-reference/internationalization/get-locale-path-and-manage-clipboard"},{"title":"Check document existence in locale","deprecated":null,"version":null,"sidebarTitle":"Check document existence in locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/i18n/exist-in-locale","href":"/api-reference/internationalization/check-document-existence-in-locale"}]},{"group":"Languages","icon":"language","pages":[{"title":"List language lists","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /site-languages","href":"/api-reference/languages/list-language-lists"},{"title":"Get a language list","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /site-languages/{_id}","href":"/api-reference/languages/get-a-language-list"},{"title":"Update a language list","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /site-languages/{_id}","href":"/api-reference/languages/update-a-language-list"},{"title":"Replace a language list","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /site-languages/{_id}","href":"/api-reference/languages/replace-a-language-list"},{"title":"List the Global fields each language translates","deprecated":null,"version":null,"sidebarTitle":"List the Global fields each language translates","openapi":"/api-reference/openapi.yaml get /site-languages/global-fields","href":"/api-reference/languages/list-the-global-fields-each-language-translates"}]},{"group":"Page Templates","icon":"table-columns","pages":[{"title":"Get a page template","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /page-template/{_id}","href":"/api-reference/page-templates/get-a-page-template"},{"title":"List the page templates","deprecated":null,"version":null,"sidebarTitle":"List the page templates","openapi":"/api-reference/openapi.yaml get /page-template/list","href":"/api-reference/page-templates/list-the-page-templates"}]}]},{"group":"Content","icon":"newspaper","pages":[{"group":"Blog Posts","icon":"newspaper","pages":[{"title":"List blog posts","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/blog","href":"/api-reference/blog-posts/list-blog-posts"},{"title":"Get a blog post","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/blog/{_id}","href":"/api-reference/blog-posts/get-a-blog-post"},{"title":"Create a blog post","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog","href":"/api-reference/blog-posts/create-a-blog-post"},{"title":"Update a blog post","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/blog/{_id}","href":"/api-reference/blog-posts/update-a-blog-post"},{"title":"Replace a blog post","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/blog/{_id}","href":"/api-reference/blog-posts/replace-a-blog-post"},{"title":"Delete a blog post","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/blog/{_id}","href":"/api-reference/blog-posts/delete-a-blog-post"},{"title":"Get the Markdown template","deprecated":null,"version":null,"sidebarTitle":"Get the Markdown template","openapi":"/api-reference/openapi.yaml get /@apostrophecms/blog/markdown-template","href":"/api-reference/blog-posts/get-the-markdown-template"},{"title":"Get the MDX template","deprecated":null,"version":null,"sidebarTitle":"Get the MDX template","openapi":"/api-reference/openapi.yaml get /@apostrophecms/blog/mdx-template","href":"/api-reference/blog-posts/get-the-mdx-template"},{"title":"Check a document before importing it","deprecated":null,"version":null,"sidebarTitle":"Check a document before importing it","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/from-markdown/validate","href":"/api-reference/blog-posts/check-a-document-before-importing-it"},{"title":"Import a post from Markdown or MDX","deprecated":null,"version":null,"sidebarTitle":"Import a post from Markdown or MDX","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/from-markdown","href":"/api-reference/blog-posts/import-a-post-from-markdown-or-mdx"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a blog post","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/publish","href":"/api-reference/blog-posts/publish-a-blog-post"},{"title":"Unpublish a blog post","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/unpublish","href":"/api-reference/blog-posts/unpublish-a-blog-post"},{"title":"Submit a blog post for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/submit","href":"/api-reference/blog-posts/submit-a-blog-post-for-review"},{"title":"Dismiss a blog post’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/dismiss-submission","href":"/api-reference/blog-posts/dismiss-a-blog-post’s-review-submission"},{"title":"Discard a blog post’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/revert-draft-to-published","href":"/api-reference/blog-posts/discard-a-blog-post’s-draft-changes"},{"title":"Restore a blog post’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/revert-published-to-previous","href":"/api-reference/blog-posts/restore-a-blog-post’s-previous-publish"},{"title":"Share a blog post’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/share","href":"/api-reference/blog-posts/share-a-blog-post’s-draft"},{"title":"Copy a blog post to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/{_id}/localize","href":"/api-reference/blog-posts/copy-a-blog-post-to-another-locale"},{"title":"List a blog post’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/blog/{_id}/locales","href":"/api-reference/blog-posts/list-a-blog-post’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish blog posts","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/publish","href":"/api-reference/blog-posts/publish-blog-posts"},{"title":"Archive blog posts","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/archive","href":"/api-reference/blog-posts/archive-blog-posts"},{"title":"Restore blog posts","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/restore","href":"/api-reference/blog-posts/restore-blog-posts"},{"title":"Copy blog posts to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/blog/localize","href":"/api-reference/blog-posts/copy-blog-posts-to-another-locale"}]}]},{"group":"Blog Categories","icon":"folder-tree","pages":[{"title":"List blog categories","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /blog-category","href":"/api-reference/blog-categories/list-blog-categories"},{"title":"Get a blog category","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /blog-category/{_id}","href":"/api-reference/blog-categories/get-a-blog-category"},{"title":"Create a blog category","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /blog-category","href":"/api-reference/blog-categories/create-a-blog-category"},{"title":"Update a blog category","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /blog-category/{_id}","href":"/api-reference/blog-categories/update-a-blog-category"},{"title":"Replace a blog category","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /blog-category/{_id}","href":"/api-reference/blog-categories/replace-a-blog-category"},{"title":"Delete a blog category","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /blog-category/{_id}","href":"/api-reference/blog-categories/delete-a-blog-category"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a blog category","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/publish","href":"/api-reference/blog-categories/publish-a-blog-category"},{"title":"Unpublish a blog category","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/unpublish","href":"/api-reference/blog-categories/unpublish-a-blog-category"},{"title":"Submit a blog category for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/submit","href":"/api-reference/blog-categories/submit-a-blog-category-for-review"},{"title":"Dismiss a blog category’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/dismiss-submission","href":"/api-reference/blog-categories/dismiss-a-blog-category’s-review-submission"},{"title":"Discard a blog category’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/revert-draft-to-published","href":"/api-reference/blog-categories/discard-a-blog-category’s-draft-changes"},{"title":"Restore a blog category’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/revert-published-to-previous","href":"/api-reference/blog-categories/restore-a-blog-category’s-previous-publish"},{"title":"Share a blog category’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/share","href":"/api-reference/blog-categories/share-a-blog-category’s-draft"},{"title":"Copy a blog category to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /blog-category/{_id}/localize","href":"/api-reference/blog-categories/copy-a-blog-category-to-another-locale"},{"title":"List a blog category’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /blog-category/{_id}/locales","href":"/api-reference/blog-categories/list-a-blog-category’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish blog categories","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /blog-category/publish","href":"/api-reference/blog-categories/publish-blog-categories"},{"title":"Archive blog categories","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /blog-category/archive","href":"/api-reference/blog-categories/archive-blog-categories"},{"title":"Restore blog categories","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /blog-category/restore","href":"/api-reference/blog-categories/restore-blog-categories"},{"title":"Copy blog categories to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /blog-category/localize","href":"/api-reference/blog-categories/copy-blog-categories-to-another-locale"}]}]},{"group":"Authors","icon":"pen-nib","pages":[{"title":"List authors","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /author","href":"/api-reference/authors/list-authors"},{"title":"Get an author","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /author/{_id}","href":"/api-reference/authors/get-an-author"},{"title":"Create an author","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /author","href":"/api-reference/authors/create-an-author"},{"title":"Update an author","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /author/{_id}","href":"/api-reference/authors/update-an-author"},{"title":"Replace an author","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /author/{_id}","href":"/api-reference/authors/replace-an-author"},{"title":"Delete an author","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /author/{_id}","href":"/api-reference/authors/delete-an-author"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an author","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /author/{_id}/publish","href":"/api-reference/authors/publish-an-author"},{"title":"Unpublish an author","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /author/{_id}/unpublish","href":"/api-reference/authors/unpublish-an-author"},{"title":"Submit an author for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /author/{_id}/submit","href":"/api-reference/authors/submit-an-author-for-review"},{"title":"Dismiss an author’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /author/{_id}/dismiss-submission","href":"/api-reference/authors/dismiss-an-author’s-review-submission"},{"title":"Discard an author’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /author/{_id}/revert-draft-to-published","href":"/api-reference/authors/discard-an-author’s-draft-changes"},{"title":"Restore an author’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /author/{_id}/revert-published-to-previous","href":"/api-reference/authors/restore-an-author’s-previous-publish"},{"title":"Share an author’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /author/{_id}/share","href":"/api-reference/authors/share-an-author’s-draft"},{"title":"Copy an author to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /author/{_id}/localize","href":"/api-reference/authors/copy-an-author-to-another-locale"},{"title":"List an author’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /author/{_id}/locales","href":"/api-reference/authors/list-an-author’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish authors","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /author/publish","href":"/api-reference/authors/publish-authors"},{"title":"Archive authors","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /author/archive","href":"/api-reference/authors/archive-authors"},{"title":"Restore authors","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /author/restore","href":"/api-reference/authors/restore-authors"},{"title":"Copy authors to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /author/localize","href":"/api-reference/authors/copy-authors-to-another-locale"}]}]},{"group":"Team Members","icon":"user-group","pages":[{"title":"List team members","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /team-member","href":"/api-reference/team-members/list-team-members"},{"title":"Get a team member","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /team-member/{_id}","href":"/api-reference/team-members/get-a-team-member"},{"title":"Create a team member","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /team-member","href":"/api-reference/team-members/create-a-team-member"},{"title":"Update a team member","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /team-member/{_id}","href":"/api-reference/team-members/update-a-team-member"},{"title":"Replace a team member","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /team-member/{_id}","href":"/api-reference/team-members/replace-a-team-member"},{"title":"Delete a team member","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /team-member/{_id}","href":"/api-reference/team-members/delete-a-team-member"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a team member","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/publish","href":"/api-reference/team-members/publish-a-team-member"},{"title":"Unpublish a team member","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/unpublish","href":"/api-reference/team-members/unpublish-a-team-member"},{"title":"Submit a team member for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/submit","href":"/api-reference/team-members/submit-a-team-member-for-review"},{"title":"Dismiss a team member’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/dismiss-submission","href":"/api-reference/team-members/dismiss-a-team-member’s-review-submission"},{"title":"Discard a team member’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/revert-draft-to-published","href":"/api-reference/team-members/discard-a-team-member’s-draft-changes"},{"title":"Restore a team member’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/revert-published-to-previous","href":"/api-reference/team-members/restore-a-team-member’s-previous-publish"},{"title":"Share a team member’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/share","href":"/api-reference/team-members/share-a-team-member’s-draft"},{"title":"Copy a team member to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /team-member/{_id}/localize","href":"/api-reference/team-members/copy-a-team-member-to-another-locale"},{"title":"List a team member’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /team-member/{_id}/locales","href":"/api-reference/team-members/list-a-team-member’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish team members","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /team-member/publish","href":"/api-reference/team-members/publish-team-members"},{"title":"Archive team members","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /team-member/archive","href":"/api-reference/team-members/archive-team-members"},{"title":"Restore team members","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /team-member/restore","href":"/api-reference/team-members/restore-team-members"},{"title":"Copy team members to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /team-member/localize","href":"/api-reference/team-members/copy-team-members-to-another-locale"}]}]},{"group":"Testimonials","icon":"quote-left","pages":[{"title":"List testimonials","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /testimonial","href":"/api-reference/testimonials/list-testimonials"},{"title":"Get a testimonial","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /testimonial/{_id}","href":"/api-reference/testimonials/get-a-testimonial"},{"title":"Create a testimonial","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /testimonial","href":"/api-reference/testimonials/create-a-testimonial"},{"title":"Update a testimonial","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /testimonial/{_id}","href":"/api-reference/testimonials/update-a-testimonial"},{"title":"Replace a testimonial","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /testimonial/{_id}","href":"/api-reference/testimonials/replace-a-testimonial"},{"title":"Delete a testimonial","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /testimonial/{_id}","href":"/api-reference/testimonials/delete-a-testimonial"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a testimonial","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/publish","href":"/api-reference/testimonials/publish-a-testimonial"},{"title":"Unpublish a testimonial","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/unpublish","href":"/api-reference/testimonials/unpublish-a-testimonial"},{"title":"Submit a testimonial for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/submit","href":"/api-reference/testimonials/submit-a-testimonial-for-review"},{"title":"Dismiss a testimonial’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/dismiss-submission","href":"/api-reference/testimonials/dismiss-a-testimonial’s-review-submission"},{"title":"Discard a testimonial’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/revert-draft-to-published","href":"/api-reference/testimonials/discard-a-testimonial’s-draft-changes"},{"title":"Restore a testimonial’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/revert-published-to-previous","href":"/api-reference/testimonials/restore-a-testimonial’s-previous-publish"},{"title":"Share a testimonial’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/share","href":"/api-reference/testimonials/share-a-testimonial’s-draft"},{"title":"Copy a testimonial to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /testimonial/{_id}/localize","href":"/api-reference/testimonials/copy-a-testimonial-to-another-locale"},{"title":"List a testimonial’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /testimonial/{_id}/locales","href":"/api-reference/testimonials/list-a-testimonial’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish testimonials","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /testimonial/publish","href":"/api-reference/testimonials/publish-testimonials"},{"title":"Archive testimonials","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /testimonial/archive","href":"/api-reference/testimonials/archive-testimonials"},{"title":"Restore testimonials","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /testimonial/restore","href":"/api-reference/testimonials/restore-testimonials"},{"title":"Copy testimonials to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /testimonial/localize","href":"/api-reference/testimonials/copy-testimonials-to-another-locale"}]}]},{"group":"FAQ Items","icon":"circle-question","pages":[{"title":"List FAQ items","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /faq-item","href":"/api-reference/faq-items/list-faq-items"},{"title":"Get an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /faq-item/{_id}","href":"/api-reference/faq-items/get-an-faq-item"},{"title":"Create an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /faq-item","href":"/api-reference/faq-items/create-an-faq-item"},{"title":"Update an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /faq-item/{_id}","href":"/api-reference/faq-items/update-an-faq-item"},{"title":"Replace an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /faq-item/{_id}","href":"/api-reference/faq-items/replace-an-faq-item"},{"title":"Delete an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /faq-item/{_id}","href":"/api-reference/faq-items/delete-an-faq-item"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/publish","href":"/api-reference/faq-items/publish-an-faq-item"},{"title":"Unpublish an FAQ item","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/unpublish","href":"/api-reference/faq-items/unpublish-an-faq-item"},{"title":"Submit an FAQ item for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/submit","href":"/api-reference/faq-items/submit-an-faq-item-for-review"},{"title":"Dismiss an FAQ item’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/dismiss-submission","href":"/api-reference/faq-items/dismiss-an-faq-item’s-review-submission"},{"title":"Discard an FAQ item’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/revert-draft-to-published","href":"/api-reference/faq-items/discard-an-faq-item’s-draft-changes"},{"title":"Restore an FAQ item’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/revert-published-to-previous","href":"/api-reference/faq-items/restore-an-faq-item’s-previous-publish"},{"title":"Share an FAQ item’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/share","href":"/api-reference/faq-items/share-an-faq-item’s-draft"},{"title":"Copy an FAQ item to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /faq-item/{_id}/localize","href":"/api-reference/faq-items/copy-an-faq-item-to-another-locale"},{"title":"List an FAQ item’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /faq-item/{_id}/locales","href":"/api-reference/faq-items/list-an-faq-item’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish FAQ items","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /faq-item/publish","href":"/api-reference/faq-items/publish-faq-items"},{"title":"Archive FAQ items","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /faq-item/archive","href":"/api-reference/faq-items/archive-faq-items"},{"title":"Restore FAQ items","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /faq-item/restore","href":"/api-reference/faq-items/restore-faq-items"},{"title":"Copy FAQ items to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /faq-item/localize","href":"/api-reference/faq-items/copy-faq-items-to-another-locale"}]}]},{"group":"FAQ Categories","icon":"layer-group","pages":[{"title":"List FAQ categories","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /faq-category","href":"/api-reference/faq-categories/list-faq-categories"},{"title":"Get an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /faq-category/{_id}","href":"/api-reference/faq-categories/get-an-faq-category"},{"title":"Create an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /faq-category","href":"/api-reference/faq-categories/create-an-faq-category"},{"title":"Update an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /faq-category/{_id}","href":"/api-reference/faq-categories/update-an-faq-category"},{"title":"Replace an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /faq-category/{_id}","href":"/api-reference/faq-categories/replace-an-faq-category"},{"title":"Delete an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /faq-category/{_id}","href":"/api-reference/faq-categories/delete-an-faq-category"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/publish","href":"/api-reference/faq-categories/publish-an-faq-category"},{"title":"Unpublish an FAQ category","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/unpublish","href":"/api-reference/faq-categories/unpublish-an-faq-category"},{"title":"Submit an FAQ category for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/submit","href":"/api-reference/faq-categories/submit-an-faq-category-for-review"},{"title":"Dismiss an FAQ category’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/dismiss-submission","href":"/api-reference/faq-categories/dismiss-an-faq-category’s-review-submission"},{"title":"Discard an FAQ category’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/revert-draft-to-published","href":"/api-reference/faq-categories/discard-an-faq-category’s-draft-changes"},{"title":"Restore an FAQ category’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/revert-published-to-previous","href":"/api-reference/faq-categories/restore-an-faq-category’s-previous-publish"},{"title":"Share an FAQ category’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/share","href":"/api-reference/faq-categories/share-an-faq-category’s-draft"},{"title":"Copy an FAQ category to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /faq-category/{_id}/localize","href":"/api-reference/faq-categories/copy-an-faq-category-to-another-locale"},{"title":"List an FAQ category’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /faq-category/{_id}/locales","href":"/api-reference/faq-categories/list-an-faq-category’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish FAQ categories","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /faq-category/publish","href":"/api-reference/faq-categories/publish-faq-categories"},{"title":"Archive FAQ categories","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /faq-category/archive","href":"/api-reference/faq-categories/archive-faq-categories"},{"title":"Restore FAQ categories","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /faq-category/restore","href":"/api-reference/faq-categories/restore-faq-categories"},{"title":"Copy FAQ categories to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /faq-category/localize","href":"/api-reference/faq-categories/copy-faq-categories-to-another-locale"}]}]},{"group":"Google Reviews","icon":"star","pages":[{"title":"List Google reviews","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /google-review","href":"/api-reference/google-reviews/list-google-reviews"},{"title":"Get a Google review","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /google-review/{_id}","href":"/api-reference/google-reviews/get-a-google-review"},{"title":"Create a Google review","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /google-review","href":"/api-reference/google-reviews/create-a-google-review"},{"title":"Update a Google review","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /google-review/{_id}","href":"/api-reference/google-reviews/update-a-google-review"},{"title":"Replace a Google review","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /google-review/{_id}","href":"/api-reference/google-reviews/replace-a-google-review"},{"title":"Delete a Google review","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /google-review/{_id}","href":"/api-reference/google-reviews/delete-a-google-review"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a Google review","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/publish","href":"/api-reference/google-reviews/publish-a-google-review"},{"title":"Unpublish a Google review","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/unpublish","href":"/api-reference/google-reviews/unpublish-a-google-review"},{"title":"Submit a Google review for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/submit","href":"/api-reference/google-reviews/submit-a-google-review-for-review"},{"title":"Dismiss a Google review’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/dismiss-submission","href":"/api-reference/google-reviews/dismiss-a-google-review’s-review-submission"},{"title":"Discard a Google review’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/revert-draft-to-published","href":"/api-reference/google-reviews/discard-a-google-review’s-draft-changes"},{"title":"Restore a Google review’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/revert-published-to-previous","href":"/api-reference/google-reviews/restore-a-google-review’s-previous-publish"},{"title":"Share a Google review’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/share","href":"/api-reference/google-reviews/share-a-google-review’s-draft"},{"title":"Copy a Google review to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /google-review/{_id}/localize","href":"/api-reference/google-reviews/copy-a-google-review-to-another-locale"},{"title":"List a Google review’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /google-review/{_id}/locales","href":"/api-reference/google-reviews/list-a-google-review’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish Google reviews","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /google-review/publish","href":"/api-reference/google-reviews/publish-google-reviews"},{"title":"Archive Google reviews","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /google-review/archive","href":"/api-reference/google-reviews/archive-google-reviews"},{"title":"Restore Google reviews","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /google-review/restore","href":"/api-reference/google-reviews/restore-google-reviews"},{"title":"Copy Google reviews to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /google-review/localize","href":"/api-reference/google-reviews/copy-google-reviews-to-another-locale"}]}]},{"group":"Instagram Posts","icon":"instagram","pages":[{"title":"List Instagram posts","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /instagram-post","href":"/api-reference/instagram-posts/list-instagram-posts"},{"title":"Get an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /instagram-post/{_id}","href":"/api-reference/instagram-posts/get-an-instagram-post"},{"title":"Create an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /instagram-post","href":"/api-reference/instagram-posts/create-an-instagram-post"},{"title":"Update an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /instagram-post/{_id}","href":"/api-reference/instagram-posts/update-an-instagram-post"},{"title":"Replace an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /instagram-post/{_id}","href":"/api-reference/instagram-posts/replace-an-instagram-post"},{"title":"Delete an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /instagram-post/{_id}","href":"/api-reference/instagram-posts/delete-an-instagram-post"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/publish","href":"/api-reference/instagram-posts/publish-an-instagram-post"},{"title":"Unpublish an Instagram post","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/unpublish","href":"/api-reference/instagram-posts/unpublish-an-instagram-post"},{"title":"Submit an Instagram post for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/submit","href":"/api-reference/instagram-posts/submit-an-instagram-post-for-review"},{"title":"Dismiss an Instagram post’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/dismiss-submission","href":"/api-reference/instagram-posts/dismiss-an-instagram-post’s-review-submission"},{"title":"Discard an Instagram post’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/revert-draft-to-published","href":"/api-reference/instagram-posts/discard-an-instagram-post’s-draft-changes"},{"title":"Restore an Instagram post’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/revert-published-to-previous","href":"/api-reference/instagram-posts/restore-an-instagram-post’s-previous-publish"},{"title":"Share an Instagram post’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/share","href":"/api-reference/instagram-posts/share-an-instagram-post’s-draft"},{"title":"Copy an Instagram post to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /instagram-post/{_id}/localize","href":"/api-reference/instagram-posts/copy-an-instagram-post-to-another-locale"},{"title":"List an Instagram post’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /instagram-post/{_id}/locales","href":"/api-reference/instagram-posts/list-an-instagram-post’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish Instagram posts","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /instagram-post/publish","href":"/api-reference/instagram-posts/publish-instagram-posts"},{"title":"Archive Instagram posts","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /instagram-post/archive","href":"/api-reference/instagram-posts/archive-instagram-posts"},{"title":"Restore Instagram posts","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /instagram-post/restore","href":"/api-reference/instagram-posts/restore-instagram-posts"},{"title":"Copy Instagram posts to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /instagram-post/localize","href":"/api-reference/instagram-posts/copy-instagram-posts-to-another-locale"}]}]},{"group":"Service Areas","icon":"map-location-dot","pages":[{"title":"List service areas","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /service-area","href":"/api-reference/service-areas/list-service-areas"},{"title":"Get a service area","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /service-area/{_id}","href":"/api-reference/service-areas/get-a-service-area"},{"title":"Create a service area","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /service-area","href":"/api-reference/service-areas/create-a-service-area"},{"title":"Update a service area","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /service-area/{_id}","href":"/api-reference/service-areas/update-a-service-area"},{"title":"Replace a service area","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /service-area/{_id}","href":"/api-reference/service-areas/replace-a-service-area"},{"title":"Delete a service area","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /service-area/{_id}","href":"/api-reference/service-areas/delete-a-service-area"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a service area","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/publish","href":"/api-reference/service-areas/publish-a-service-area"},{"title":"Unpublish a service area","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/unpublish","href":"/api-reference/service-areas/unpublish-a-service-area"},{"title":"Submit a service area for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/submit","href":"/api-reference/service-areas/submit-a-service-area-for-review"},{"title":"Dismiss a service area’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/dismiss-submission","href":"/api-reference/service-areas/dismiss-a-service-area’s-review-submission"},{"title":"Discard a service area’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/revert-draft-to-published","href":"/api-reference/service-areas/discard-a-service-area’s-draft-changes"},{"title":"Restore a service area’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/revert-published-to-previous","href":"/api-reference/service-areas/restore-a-service-area’s-previous-publish"},{"title":"Share a service area’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/share","href":"/api-reference/service-areas/share-a-service-area’s-draft"},{"title":"Copy a service area to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /service-area/{_id}/localize","href":"/api-reference/service-areas/copy-a-service-area-to-another-locale"},{"title":"List a service area’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /service-area/{_id}/locales","href":"/api-reference/service-areas/list-a-service-area’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish service areas","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /service-area/publish","href":"/api-reference/service-areas/publish-service-areas"},{"title":"Archive service areas","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /service-area/archive","href":"/api-reference/service-areas/archive-service-areas"},{"title":"Restore service areas","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /service-area/restore","href":"/api-reference/service-areas/restore-service-areas"},{"title":"Copy service areas to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /service-area/localize","href":"/api-reference/service-areas/copy-service-areas-to-another-locale"}]}]},{"group":"Cookies","icon":"cookie-bite","pages":[{"title":"List cookies","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /cookie","href":"/api-reference/cookies/list-cookies"},{"title":"Get a cookie","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /cookie/{_id}","href":"/api-reference/cookies/get-a-cookie"},{"title":"Create a cookie","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /cookie","href":"/api-reference/cookies/create-a-cookie"},{"title":"Update a cookie","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /cookie/{_id}","href":"/api-reference/cookies/update-a-cookie"},{"title":"Replace a cookie","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /cookie/{_id}","href":"/api-reference/cookies/replace-a-cookie"},{"title":"Delete a cookie","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /cookie/{_id}","href":"/api-reference/cookies/delete-a-cookie"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a cookie","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/publish","href":"/api-reference/cookies/publish-a-cookie"},{"title":"Unpublish a cookie","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/unpublish","href":"/api-reference/cookies/unpublish-a-cookie"},{"title":"Submit a cookie for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/submit","href":"/api-reference/cookies/submit-a-cookie-for-review"},{"title":"Dismiss a cookie’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/dismiss-submission","href":"/api-reference/cookies/dismiss-a-cookie’s-review-submission"},{"title":"Discard a cookie’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/revert-draft-to-published","href":"/api-reference/cookies/discard-a-cookie’s-draft-changes"},{"title":"Restore a cookie’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/revert-published-to-previous","href":"/api-reference/cookies/restore-a-cookie’s-previous-publish"},{"title":"Share a cookie’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/share","href":"/api-reference/cookies/share-a-cookie’s-draft"},{"title":"Copy a cookie to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /cookie/{_id}/localize","href":"/api-reference/cookies/copy-a-cookie-to-another-locale"},{"title":"List a cookie’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /cookie/{_id}/locales","href":"/api-reference/cookies/list-a-cookie’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish cookies","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /cookie/publish","href":"/api-reference/cookies/publish-cookies"},{"title":"Archive cookies","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /cookie/archive","href":"/api-reference/cookies/archive-cookies"},{"title":"Restore cookies","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /cookie/restore","href":"/api-reference/cookies/restore-cookies"},{"title":"Copy cookies to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /cookie/localize","href":"/api-reference/cookies/copy-cookies-to-another-locale"}]}]}]},{"group":"Media","icon":"photo-film","pages":[{"group":"Media","icon":"photo-film","pages":[{"group":"Images","icon":"image","pages":[{"title":"List images","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image","href":"/api-reference/media/list-images"},{"title":"Get an image","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image/{_id}","href":"/api-reference/media/get-an-image"},{"title":"Create an image","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image","href":"/api-reference/media/create-an-image"},{"title":"Update an image","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/image/{_id}","href":"/api-reference/media/update-an-image"},{"title":"Replace an image","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/image/{_id}","href":"/api-reference/media/replace-an-image"},{"title":"Delete an image","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/image/{_id}","href":"/api-reference/media/delete-an-image"},{"title":"Crop images to a widget’s aspect ratio","deprecated":null,"version":null,"sidebarTitle":"Crop images to a widget’s aspect ratio","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/autocrop","href":"/api-reference/media/crop-images-to-a-widget’s-aspect-ratio"},{"title":"Redirect to an image’s file","deprecated":null,"version":null,"sidebarTitle":"Redirect to an image’s file","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image/{imageId}/src","href":"/api-reference/media/redirect-to-an-image’s-file"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an image","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/publish","href":"/api-reference/media/publish-an-image"},{"title":"Unpublish an image","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/unpublish","href":"/api-reference/media/unpublish-an-image"},{"title":"Submit an image for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/submit","href":"/api-reference/media/submit-an-image-for-review"},{"title":"Dismiss an image’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/dismiss-submission","href":"/api-reference/media/dismiss-an-image’s-review-submission"},{"title":"Discard an image’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/revert-draft-to-published","href":"/api-reference/media/discard-an-image’s-draft-changes"},{"title":"Restore an image’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/revert-published-to-previous","href":"/api-reference/media/restore-an-image’s-previous-publish"},{"title":"Share an image’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/share","href":"/api-reference/media/share-an-image’s-draft"},{"title":"Copy an image to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/{_id}/localize","href":"/api-reference/media/copy-an-image-to-another-locale"},{"title":"List an image’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image/{_id}/locales","href":"/api-reference/media/list-an-image’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish images","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/publish","href":"/api-reference/media/publish-images"},{"title":"Archive images","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/archive","href":"/api-reference/media/archive-images"},{"title":"Restore images","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/restore","href":"/api-reference/media/restore-images"},{"title":"Copy images to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/localize","href":"/api-reference/media/copy-images-to-another-locale"},{"title":"Tag or untag images","deprecated":null,"version":null,"sidebarTitle":"Tag many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image/tag","href":"/api-reference/media/tag-or-untag-images"}]}]},{"group":"Files","icon":"file","pages":[{"title":"List files","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file","href":"/api-reference/media/list-files"},{"title":"Get a file","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file/{_id}","href":"/api-reference/media/get-a-file"},{"title":"Create a file","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file","href":"/api-reference/media/create-a-file"},{"title":"Update a file","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/file/{_id}","href":"/api-reference/media/update-a-file"},{"title":"Replace a file","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/file/{_id}","href":"/api-reference/media/replace-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/file/{_id}","href":"/api-reference/media/delete-a-file"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a file","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/publish","href":"/api-reference/media/publish-a-file"},{"title":"Unpublish a file","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/unpublish","href":"/api-reference/media/unpublish-a-file"},{"title":"Submit a file for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/submit","href":"/api-reference/media/submit-a-file-for-review"},{"title":"Dismiss a file’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/dismiss-submission","href":"/api-reference/media/dismiss-a-file’s-review-submission"},{"title":"Discard a file’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/revert-draft-to-published","href":"/api-reference/media/discard-a-file’s-draft-changes"},{"title":"Restore a file’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/revert-published-to-previous","href":"/api-reference/media/restore-a-file’s-previous-publish"},{"title":"Share a file’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/share","href":"/api-reference/media/share-a-file’s-draft"},{"title":"Copy a file to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/{_id}/localize","href":"/api-reference/media/copy-a-file-to-another-locale"},{"title":"List a file’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file/{_id}/locales","href":"/api-reference/media/list-a-file’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish files","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/publish","href":"/api-reference/media/publish-files"},{"title":"Archive files","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/archive","href":"/api-reference/media/archive-files"},{"title":"Restore files","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/restore","href":"/api-reference/media/restore-files"},{"title":"Copy files to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file/localize","href":"/api-reference/media/copy-files-to-another-locale"}]}]},{"group":"Image tags","icon":"tag","pages":[{"title":"List image tags","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image-tag","href":"/api-reference/media/list-image-tags"},{"title":"Get an image tag","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image-tag/{_id}","href":"/api-reference/media/get-an-image-tag"},{"title":"Create an image tag","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag","href":"/api-reference/media/create-an-image-tag"},{"title":"Update an image tag","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/image-tag/{_id}","href":"/api-reference/media/update-an-image-tag"},{"title":"Replace an image tag","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/image-tag/{_id}","href":"/api-reference/media/replace-an-image-tag"},{"title":"Delete an image tag","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/image-tag/{_id}","href":"/api-reference/media/delete-an-image-tag"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish an image tag","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/publish","href":"/api-reference/media/publish-an-image-tag"},{"title":"Unpublish an image tag","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/unpublish","href":"/api-reference/media/unpublish-an-image-tag"},{"title":"Submit an image tag for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/submit","href":"/api-reference/media/submit-an-image-tag-for-review"},{"title":"Dismiss an image tag’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/dismiss-submission","href":"/api-reference/media/dismiss-an-image-tag’s-review-submission"},{"title":"Discard an image tag’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/revert-draft-to-published","href":"/api-reference/media/discard-an-image-tag’s-draft-changes"},{"title":"Restore an image tag’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/revert-published-to-previous","href":"/api-reference/media/restore-an-image-tag’s-previous-publish"},{"title":"Share an image tag’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/share","href":"/api-reference/media/share-an-image-tag’s-draft"},{"title":"Copy an image tag to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/{_id}/localize","href":"/api-reference/media/copy-an-image-tag-to-another-locale"},{"title":"List an image tag’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/image-tag/{_id}/locales","href":"/api-reference/media/list-an-image-tag’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish image tags","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/publish","href":"/api-reference/media/publish-image-tags"},{"title":"Archive image tags","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/archive","href":"/api-reference/media/archive-image-tags"},{"title":"Restore image tags","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/restore","href":"/api-reference/media/restore-image-tags"},{"title":"Copy image tags to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/image-tag/localize","href":"/api-reference/media/copy-image-tags-to-another-locale"}]}]},{"group":"File tags","icon":"tags","pages":[{"title":"List file tags","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file-tag","href":"/api-reference/media/list-file-tags"},{"title":"Get a file tag","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file-tag/{_id}","href":"/api-reference/media/get-a-file-tag"},{"title":"Create a file tag","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag","href":"/api-reference/media/create-a-file-tag"},{"title":"Update a file tag","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/file-tag/{_id}","href":"/api-reference/media/update-a-file-tag"},{"title":"Replace a file tag","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/file-tag/{_id}","href":"/api-reference/media/replace-a-file-tag"},{"title":"Delete a file tag","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/file-tag/{_id}","href":"/api-reference/media/delete-a-file-tag"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a file tag","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/publish","href":"/api-reference/media/publish-a-file-tag"},{"title":"Unpublish a file tag","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/unpublish","href":"/api-reference/media/unpublish-a-file-tag"},{"title":"Submit a file tag for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/submit","href":"/api-reference/media/submit-a-file-tag-for-review"},{"title":"Dismiss a file tag’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/dismiss-submission","href":"/api-reference/media/dismiss-a-file-tag’s-review-submission"},{"title":"Discard a file tag’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/revert-draft-to-published","href":"/api-reference/media/discard-a-file-tag’s-draft-changes"},{"title":"Restore a file tag’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/revert-published-to-previous","href":"/api-reference/media/restore-a-file-tag’s-previous-publish"},{"title":"Share a file tag’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/share","href":"/api-reference/media/share-a-file-tag’s-draft"},{"title":"Copy a file tag to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/{_id}/localize","href":"/api-reference/media/copy-a-file-tag-to-another-locale"},{"title":"List a file tag’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/file-tag/{_id}/locales","href":"/api-reference/media/list-a-file-tag’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish file tags","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/publish","href":"/api-reference/media/publish-file-tags"},{"title":"Archive file tags","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/archive","href":"/api-reference/media/archive-file-tags"},{"title":"Restore file tags","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/restore","href":"/api-reference/media/restore-file-tags"},{"title":"Copy file tags to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/file-tag/localize","href":"/api-reference/media/copy-file-tags-to-another-locale"}]}]}]},{"group":"Videos","icon":"video","pages":[{"title":"List videos","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /video","href":"/api-reference/videos/list-videos"},{"title":"Get a video","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /video/{_id}","href":"/api-reference/videos/get-a-video"},{"title":"Create a video","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /video","href":"/api-reference/videos/create-a-video"},{"title":"Update a video","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /video/{_id}","href":"/api-reference/videos/update-a-video"},{"title":"Replace a video","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /video/{_id}","href":"/api-reference/videos/replace-a-video"},{"title":"Delete a video","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /video/{_id}","href":"/api-reference/videos/delete-a-video"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a video","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /video/{_id}/publish","href":"/api-reference/videos/publish-a-video"},{"title":"Unpublish a video","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /video/{_id}/unpublish","href":"/api-reference/videos/unpublish-a-video"},{"title":"Submit a video for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /video/{_id}/submit","href":"/api-reference/videos/submit-a-video-for-review"},{"title":"Dismiss a video’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /video/{_id}/dismiss-submission","href":"/api-reference/videos/dismiss-a-video’s-review-submission"},{"title":"Discard a video’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /video/{_id}/revert-draft-to-published","href":"/api-reference/videos/discard-a-video’s-draft-changes"},{"title":"Restore a video’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /video/{_id}/revert-published-to-previous","href":"/api-reference/videos/restore-a-video’s-previous-publish"},{"title":"Share a video’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /video/{_id}/share","href":"/api-reference/videos/share-a-video’s-draft"},{"title":"Copy a video to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /video/{_id}/localize","href":"/api-reference/videos/copy-a-video-to-another-locale"},{"title":"List a video’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /video/{_id}/locales","href":"/api-reference/videos/list-a-video’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish videos","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /video/publish","href":"/api-reference/videos/publish-videos"},{"title":"Archive videos","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /video/archive","href":"/api-reference/videos/archive-videos"},{"title":"Restore videos","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /video/restore","href":"/api-reference/videos/restore-videos"},{"title":"Copy videos to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /video/localize","href":"/api-reference/videos/copy-videos-to-another-locale"}]}]},{"group":"Image Folders","icon":"folder-open","pages":[{"title":"List image folders","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /image-folder","href":"/api-reference/image-folders/list-image-folders"},{"title":"Get an image folder","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /image-folder/{_id}","href":"/api-reference/image-folders/get-an-image-folder"},{"title":"Create an image folder","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /image-folder","href":"/api-reference/image-folders/create-an-image-folder"},{"title":"Update an image folder","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /image-folder/{_id}","href":"/api-reference/image-folders/update-an-image-folder"},{"title":"Replace an image folder","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /image-folder/{_id}","href":"/api-reference/image-folders/replace-an-image-folder"},{"title":"Delete an image folder","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /image-folder/{_id}","href":"/api-reference/image-folders/delete-an-image-folder"},{"title":"Get the image folder tree","deprecated":null,"version":null,"sidebarTitle":"Get the image folder tree","openapi":"/api-reference/openapi.yaml get /image-folder/tree","href":"/api-reference/image-folders/get-the-image-folder-tree"},{"title":"List a folder’s photos","deprecated":null,"version":null,"sidebarTitle":"List a folder’s photos","openapi":"/api-reference/openapi.yaml get /image-folder/{_id}/photos","href":"/api-reference/image-folders/list-a-folder’s-photos"},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Archive image folders","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /image-folder/archive","href":"/api-reference/image-folders/archive-image-folders"},{"title":"Restore image folders","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /image-folder/restore","href":"/api-reference/image-folders/restore-image-folders"}]}]},{"group":"File Folders","icon":"folder","pages":[{"title":"List file folders","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /file-folder","href":"/api-reference/file-folders/list-file-folders"},{"title":"Get a file folder","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /file-folder/{_id}","href":"/api-reference/file-folders/get-a-file-folder"},{"title":"Create a file folder","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /file-folder","href":"/api-reference/file-folders/create-a-file-folder"},{"title":"Update a file folder","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /file-folder/{_id}","href":"/api-reference/file-folders/update-a-file-folder"},{"title":"Replace a file folder","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /file-folder/{_id}","href":"/api-reference/file-folders/replace-a-file-folder"},{"title":"Delete a file folder","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /file-folder/{_id}","href":"/api-reference/file-folders/delete-a-file-folder"},{"title":"Get the file folder tree","deprecated":null,"version":null,"sidebarTitle":"Get the file folder tree","openapi":"/api-reference/openapi.yaml get /file-folder/tree","href":"/api-reference/file-folders/get-the-file-folder-tree"},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Archive file folders","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /file-folder/archive","href":"/api-reference/file-folders/archive-file-folders"},{"title":"Restore file folders","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /file-folder/restore","href":"/api-reference/file-folders/restore-file-folders"}]}]},{"group":"Video Folders","icon":"folder-closed","pages":[{"title":"List video folders","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /video-folder","href":"/api-reference/video-folders/list-video-folders"},{"title":"Get a video folder","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /video-folder/{_id}","href":"/api-reference/video-folders/get-a-video-folder"},{"title":"Create a video folder","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /video-folder","href":"/api-reference/video-folders/create-a-video-folder"},{"title":"Update a video folder","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /video-folder/{_id}","href":"/api-reference/video-folders/update-a-video-folder"},{"title":"Replace a video folder","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /video-folder/{_id}","href":"/api-reference/video-folders/replace-a-video-folder"},{"title":"Delete a video folder","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /video-folder/{_id}","href":"/api-reference/video-folders/delete-a-video-folder"},{"title":"Get the video folder tree","deprecated":null,"version":null,"sidebarTitle":"Get the video folder tree","openapi":"/api-reference/openapi.yaml get /video-folder/tree","href":"/api-reference/video-folders/get-the-video-folder-tree"},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Archive video folders","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /video-folder/archive","href":"/api-reference/video-folders/archive-video-folders"},{"title":"Restore video folders","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /video-folder/restore","href":"/api-reference/video-folders/restore-video-folders"}]}]},{"group":"Photo Albums","icon":"images","pages":[{"title":"List photo albums","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /photo-album","href":"/api-reference/photo-albums/list-photo-albums"},{"title":"Get a photo album","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /photo-album/{_id}","href":"/api-reference/photo-albums/get-a-photo-album"},{"title":"Create a photo album","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /photo-album","href":"/api-reference/photo-albums/create-a-photo-album"},{"title":"Update a photo album","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /photo-album/{_id}","href":"/api-reference/photo-albums/update-a-photo-album"},{"title":"Replace a photo album","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /photo-album/{_id}","href":"/api-reference/photo-albums/replace-a-photo-album"},{"title":"Delete a photo album","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /photo-album/{_id}","href":"/api-reference/photo-albums/delete-a-photo-album"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a photo album","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/publish","href":"/api-reference/photo-albums/publish-a-photo-album"},{"title":"Unpublish a photo album","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/unpublish","href":"/api-reference/photo-albums/unpublish-a-photo-album"},{"title":"Submit a photo album for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/submit","href":"/api-reference/photo-albums/submit-a-photo-album-for-review"},{"title":"Dismiss a photo album’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/dismiss-submission","href":"/api-reference/photo-albums/dismiss-a-photo-album’s-review-submission"},{"title":"Discard a photo album’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/revert-draft-to-published","href":"/api-reference/photo-albums/discard-a-photo-album’s-draft-changes"},{"title":"Restore a photo album’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/revert-published-to-previous","href":"/api-reference/photo-albums/restore-a-photo-album’s-previous-publish"},{"title":"Share a photo album’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/share","href":"/api-reference/photo-albums/share-a-photo-album’s-draft"},{"title":"Copy a photo album to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /photo-album/{_id}/localize","href":"/api-reference/photo-albums/copy-a-photo-album-to-another-locale"},{"title":"List a photo album’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /photo-album/{_id}/locales","href":"/api-reference/photo-albums/list-a-photo-album’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish photo albums","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /photo-album/publish","href":"/api-reference/photo-albums/publish-photo-albums"},{"title":"Archive photo albums","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /photo-album/archive","href":"/api-reference/photo-albums/archive-photo-albums"},{"title":"Restore photo albums","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /photo-album/restore","href":"/api-reference/photo-albums/restore-photo-albums"},{"title":"Copy photo albums to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /photo-album/localize","href":"/api-reference/photo-albums/copy-photo-albums-to-another-locale"}]}]},{"group":"Photo Feeds","icon":"rss","pages":[{"title":"List photo feeds","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /photo-feed","href":"/api-reference/photo-feeds/list-photo-feeds"},{"title":"Get a photo feed","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /photo-feed/{_id}","href":"/api-reference/photo-feeds/get-a-photo-feed"},{"title":"Create a photo feed","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /photo-feed","href":"/api-reference/photo-feeds/create-a-photo-feed"},{"title":"Update a photo feed","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /photo-feed/{_id}","href":"/api-reference/photo-feeds/update-a-photo-feed"},{"title":"Replace a photo feed","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /photo-feed/{_id}","href":"/api-reference/photo-feeds/replace-a-photo-feed"},{"title":"Delete a photo feed","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /photo-feed/{_id}","href":"/api-reference/photo-feeds/delete-a-photo-feed"},{"title":"List a feed’s photos","deprecated":null,"version":null,"sidebarTitle":"List a feed’s photos","openapi":"/api-reference/openapi.yaml get /photo-feed/{_id}/photos","href":"/api-reference/photo-feeds/list-a-feed’s-photos"},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Archive photo feeds","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /photo-feed/archive","href":"/api-reference/photo-feeds/archive-photo-feeds"},{"title":"Restore photo feeds","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /photo-feed/restore","href":"/api-reference/photo-feeds/restore-photo-feeds"}]}]},{"group":"Attachments","icon":"paperclip","pages":[{"title":"Upload media file","deprecated":null,"version":null,"sidebarTitle":"Upload media file","openapi":"/api-reference/openapi.yaml post /@apostrophecms/attachment/upload","href":"/api-reference/attachments/upload-media-file"},{"title":"Crop image attachment","deprecated":null,"version":null,"sidebarTitle":"Crop image attachment","openapi":"/api-reference/openapi.yaml post /@apostrophecms/attachment/crop","href":"/api-reference/attachments/crop-image-attachment"}]},{"group":"Fetchski Media","icon":"image","pages":[{"title":"List images","deprecated":null,"version":null,"sidebarTitle":"List images","openapi":"/api-reference/openapi.yaml get /fetchski-media/images","href":"/api-reference/fetchski-media/list-images"},{"title":"List videos","deprecated":null,"version":null,"sidebarTitle":"List videos","openapi":"/api-reference/openapi.yaml get /fetchski-media/videos","href":"/api-reference/fetchski-media/list-videos"},{"title":"Get one image","deprecated":null,"version":null,"sidebarTitle":"Get one image","openapi":"/api-reference/openapi.yaml get /fetchski-media/images/{id}","href":"/api-reference/fetchski-media/get-one-image"},{"title":"Get one video","deprecated":null,"version":null,"sidebarTitle":"Get one video","openapi":"/api-reference/openapi.yaml get /fetchski-media/videos/{id}","href":"/api-reference/fetchski-media/get-one-video"}]}]},{"group":"Forms","icon":"clipboard-list","pages":[{"group":"Forms","icon":"clipboard-list","pages":[{"title":"List forms","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/api-reference/openapi.yaml get /@apostrophecms/form","href":"/api-reference/forms/list-forms"},{"title":"Get a form","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/api-reference/openapi.yaml get /@apostrophecms/form/{_id}","href":"/api-reference/forms/get-a-form"},{"title":"Create a form","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form","href":"/api-reference/forms/create-a-form"},{"title":"Update a form","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/api-reference/openapi.yaml patch /@apostrophecms/form/{_id}","href":"/api-reference/forms/update-a-form"},{"title":"Replace a form","deprecated":null,"version":null,"sidebarTitle":"Replace","openapi":"/api-reference/openapi.yaml put /@apostrophecms/form/{_id}","href":"/api-reference/forms/replace-a-form"},{"title":"Delete a form","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/api-reference/openapi.yaml delete /@apostrophecms/form/{_id}","href":"/api-reference/forms/delete-a-form"},{"group":"Publishing","icon":"paper-plane","pages":[{"title":"Publish a form","deprecated":null,"version":null,"sidebarTitle":"Publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/publish","href":"/api-reference/forms/publish-a-form"},{"title":"Unpublish a form","deprecated":null,"version":null,"sidebarTitle":"Unpublish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/unpublish","href":"/api-reference/forms/unpublish-a-form"},{"title":"Submit a form for review","deprecated":null,"version":null,"sidebarTitle":"Submit for review","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/submit","href":"/api-reference/forms/submit-a-form-for-review"},{"title":"Dismiss a form’s review submission","deprecated":null,"version":null,"sidebarTitle":"Dismiss a submission","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/dismiss-submission","href":"/api-reference/forms/dismiss-a-form’s-review-submission"},{"title":"Discard a form’s draft changes","deprecated":null,"version":null,"sidebarTitle":"Discard draft changes","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/revert-draft-to-published","href":"/api-reference/forms/discard-a-form’s-draft-changes"},{"title":"Restore a form’s previous publish","deprecated":null,"version":null,"sidebarTitle":"Restore previous publish","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/revert-published-to-previous","href":"/api-reference/forms/restore-a-form’s-previous-publish"},{"title":"Share a form’s draft","deprecated":null,"version":null,"sidebarTitle":"Share the draft","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/share","href":"/api-reference/forms/share-a-form’s-draft"},{"title":"Copy a form to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/{_id}/localize","href":"/api-reference/forms/copy-a-form-to-another-locale"},{"title":"List a form’s locales","deprecated":null,"version":null,"sidebarTitle":"List locales","openapi":"/api-reference/openapi.yaml get /@apostrophecms/form/{_id}/locales","href":"/api-reference/forms/list-a-form’s-locales"}]},{"group":"Batch jobs","icon":"layer-group","pages":[{"title":"Publish forms","deprecated":null,"version":null,"sidebarTitle":"Publish many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/publish","href":"/api-reference/forms/publish-forms"},{"title":"Archive forms","deprecated":null,"version":null,"sidebarTitle":"Archive many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/archive","href":"/api-reference/forms/archive-forms"},{"title":"Restore forms","deprecated":null,"version":null,"sidebarTitle":"Restore many","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/restore","href":"/api-reference/forms/restore-forms"},{"title":"Copy forms to another locale","deprecated":null,"version":null,"sidebarTitle":"Copy many to a locale","openapi":"/api-reference/openapi.yaml post /@apostrophecms/form/localize","href":"/api-reference/forms/copy-forms-to-another-locale"}]}]},{"group":"Form Submissions","icon":"inbox","pages":[{"title":"List forms and their submission counts","deprecated":null,"version":null,"sidebarTitle":"List forms and their submission counts","openapi":"/api-reference/openapi.yaml get /form-submission/forms","href":"/api-reference/form-submissions/list-forms-and-their-submission-counts"},{"title":"List a form’s submissions","deprecated":null,"version":null,"sidebarTitle":"List a form’s submissions","openapi":"/api-reference/openapi.yaml get /form-submission/list","href":"/api-reference/form-submissions/list-a-form’s-submissions"},{"title":"Export a form’s submissions as CSV","deprecated":null,"version":null,"sidebarTitle":"Export a form’s submissions as CSV","openapi":"/api-reference/openapi.yaml get /form-submission/export","href":"/api-reference/form-submissions/export-a-form’s-submissions-as-csv"}]}]},{"group":"Ads \u0026 Conversions","icon":"chart-line","pages":[{"group":"Conversion Events","icon":"bolt","pages":[{"title":"List conversion events (incremental sync)","description":"Events in the order they last CHANGED (`updatedAt`, then `eventId`), oldest first — built for incremental sync. Keep the response’s `nextCursor` and send it as `since` next time: you receive every new event and every later change to one (a delivery outcome, an adjustment) exactly once more. While `hasMore` is true, fetch again at once.\n\nFilters narrow the page; `from` / `to` filter on when the conversion happened (`occurredAt`), `since` on when it last changed.\n\nFields the visitor’s consent did not allow are absent. The visitor’s IP address and user agent are never returned.\n\n**Access:** an API key with `conversions:read` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `conversion-events:view` permission. Anonymous callers get 404.\n\n**Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`.","deprecated":null,"version":null,"sidebarTitle":"List conversion events (incremental sync)","openapi":"/api-reference/openapi.yaml get /conversion-event","href":"/api-reference/conversion-events/list-conversion-events-incremental-sync"},{"title":"Get one conversion event","deprecated":null,"version":null,"sidebarTitle":"Get one conversion event","openapi":"/api-reference/openapi.yaml get /conversion-event/{eventId}","href":"/api-reference/conversion-events/get-one-conversion-event"},{"title":"Post a conversion another system saw","description":"Records a fact the site cannot see itself — a reservation paid on a booking site, a lead that became a customer — as an event with `source: external`, and delivers it to the ad platforms the Conversion reports to (Google Ads, Google Analytics 4, Meta, TikTok server APIs). Google Analytics only accepts it within 72 hours of when it happened.\n\n**Joining.** The CMS joins the fact to a visitor’s journey with `match`, strongest first (visitor ID, the `fk_at` token, `_gcl_au`, a click ID, hashed email / phone), and copies that visitor’s attribution onto the event. `join.by` in the answer says which matched. The producer’s own click IDs win over the visitor record’s; its browser IDs only fill gaps.\n\n**Consent.** The producer’s `consent` flags govern what is sent about the fact (omitted flags are granted). A denial trims what is sent — no contact details or browser data, Google receives `CONSENT_DENIED` — but the conversion is always stored and delivered.\n\n**Browser context.** Send the customer’s `client` (IP, user agent) and `page.url` as captured when they booked; with them the fact reaches Meta as a `website` event (de-duplicated against the pixel), without them as `system_generated`.\n\n**Idempotent on `eventId`.** Posting the same fact again returns the stored event with `created: false`; the same ID with different content is a 409. Retry freely.\n\n**Access:** an API key with `conversions:write` — or its group master `ads:all`, or `admin:all` — or a signed-in user holding the `conversion-events:write` permission. Anonymous callers get 404.\n\n**Signed:** every API key must sign this request (`X-Fetchski-Timestamp` + `X-Fetchski-Signature`, see the headers below), whatever its own signing mode. Signed-in users in the CMS need no signature. [Signing requests](/signing) shows how, from the API and both SDKs.\n\n**Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`.","deprecated":null,"version":null,"sidebarTitle":"Post a conversion another system saw","openapi":"/api-reference/openapi.yaml post /conversion-event/external","href":"/api-reference/conversion-events/post-a-conversion-another-system-saw"},{"title":"Retract or restate a conversion event","deprecated":null,"version":null,"sidebarTitle":"Retract or restate a conversion event","openapi":"/api-reference/openapi.yaml post /conversion-event/{eventId}/adjust","href":"/api-reference/conversion-events/retract-or-restate-a-conversion-event"}]},{"group":"Visitor Attribution","icon":"route","pages":[{"title":"Find visitors by an identifier","deprecated":null,"version":null,"sidebarTitle":"Find visitors by an identifier","openapi":"/api-reference/openapi.yaml get /visitor-attribution","href":"/api-reference/visitor-attribution/find-visitors-by-an-identifier"},{"title":"Get one visitor’s attribution","deprecated":null,"version":null,"sidebarTitle":"Get one visitor’s attribution","openapi":"/api-reference/openapi.yaml get /visitor-attribution/{visitorId}","href":"/api-reference/visitor-attribution/get-one-visitor’s-attribution"}]},{"group":"Ads Metrics","icon":"chart-column","pages":[{"title":"Ad-click landings and conversions, aggregated","deprecated":null,"version":null,"sidebarTitle":"Ad-click landings and conversions, aggregated","openapi":"/api-reference/openapi.yaml get /ads-metrics","href":"/api-reference/ads-metrics/ad-click-landings-and-conversions-aggregated"}]},{"group":"Conversions","icon":"bullseye","pages":[{"title":"Conversions the page can fire (public)","deprecated":null,"version":null,"sidebarTitle":"Conversions the page can fire (public)","openapi":"/api-reference/openapi.yaml get /conversion/active","href":"/api-reference/conversions/conversions-the-page-can-fire-public"},{"title":"List the enabled Conversions","deprecated":null,"version":null,"sidebarTitle":"List the enabled Conversions","openapi":"/api-reference/openapi.yaml get /conversion/definitions","href":"/api-reference/conversions/list-the-enabled-conversions"}]}]},{"group":"Analytics","icon":"chart-simple","pages":[{"title":"List captured page views","deprecated":null,"version":null,"sidebarTitle":"List captured page views","openapi":"/api-reference/openapi.yaml get /request-log/requests","href":"/api-reference/request-log/list-captured-page-views"},{"title":"List captured query parameters","deprecated":null,"version":null,"sidebarTitle":"List captured query parameters","openapi":"/api-reference/openapi.yaml get /request-log/params","href":"/api-reference/request-log/list-captured-query-parameters"}]},{"group":"Signing in (people)","icon":"right-to-bracket","pages":[{"group":"Authentication","icon":"right-to-bracket","pages":[{"title":"Login to get authentication token","deprecated":null,"version":null,"sidebarTitle":"Login to get authentication token","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/login","href":"/api-reference/authentication/login-to-get-authentication-token"},{"title":"Logout and invalidate session","deprecated":null,"version":null,"sidebarTitle":"Logout and invalidate session","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/logout","href":"/api-reference/authentication/logout-and-invalidate-session"},{"title":"Get current user information","deprecated":null,"version":null,"sidebarTitle":"Get current user information","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/whoami","href":"/api-reference/authentication/get-current-user-information"},{"title":"Get what the login screen shows (POST)","deprecated":null,"version":null,"sidebarTitle":"Get what the login screen shows (POST)","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/context","href":"/api-reference/authentication/get-what-the-login-screen-shows-post"},{"title":"Get what a login requirement needs","deprecated":null,"version":null,"sidebarTitle":"Get what a login requirement needs","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/requirement-props","href":"/api-reference/authentication/get-what-a-login-requirement-needs"},{"title":"Verify a login requirement","deprecated":null,"version":null,"sidebarTitle":"Verify a login requirement","openapi":"/api-reference/openapi.yaml post /@apostrophecms/login/requirement-verify","href":"/api-reference/authentication/verify-a-login-requirement"}]},{"group":"SDK Packages","icon":"folder","pages":[{"title":"Get an SDK’s npm package document","deprecated":null,"version":null,"sidebarTitle":"Get an SDK’s npm package document","openapi":"/api-reference/openapi.yaml get /sdk/npm/{package}","href":"/api-reference/sdk-packages/get-an-sdk’s-npm-package-document"},{"title":"Get an SDK’s npm package document (name unencoded)","deprecated":null,"version":null,"sidebarTitle":"Get an SDK’s npm package document (name unencoded)","openapi":"/api-reference/openapi.yaml get /sdk/npm/{scope}/{name}","href":"/api-reference/sdk-packages/get-an-sdk’s-npm-package-document-name-unencoded"},{"title":"Download an SDK’s npm tarball","deprecated":null,"version":null,"sidebarTitle":"Download an SDK’s npm tarball","openapi":"/api-reference/openapi.yaml get /sdk/npm/{scope}/{name}/-/{file}","href":"/api-reference/sdk-packages/download-an-sdk’s-npm-tarball"},{"title":"Get the SDKs’ Composer repository","deprecated":null,"version":null,"sidebarTitle":"Get the SDKs’ Composer repository","openapi":"/api-reference/openapi.yaml get /sdk/composer/packages.json","href":"/api-reference/sdk-packages/get-the-sdks’-composer-repository"},{"title":"Get an SDK’s Composer versions","deprecated":null,"version":null,"sidebarTitle":"Get an SDK’s Composer versions","openapi":"/api-reference/openapi.yaml get /sdk/composer/p2/{vendor}/{file}","href":"/api-reference/sdk-packages/get-an-sdk’s-composer-versions"},{"title":"Download an SDK’s Composer zip","deprecated":null,"version":null,"sidebarTitle":"Download an SDK’s Composer zip","openapi":"/api-reference/openapi.yaml get /sdk/composer/dist/{vendor}/{package}/{file}","href":"/api-reference/sdk-packages/download-an-sdk’s-composer-zip"}]}]}]}]},"basePath":"","title":"Get one conversion event - Fetchski Attract Docs","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DDHbuAIY.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}