{ "openapi": "3.1.0", "info": { "title": "AnyTrack Customer API", "description": "Read-only access to properties, reports, conversions, integrations, connections, destinations and webhooks. Requests are limited to 60 per minute per account.", "version": "1.0.0" }, "servers": [ { "url": "/v1" } ], "paths": { "/properties": { "get": { "operationId": "listProperties", "summary": "List the account properties", "tags": [ "Properties" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1, "maxLength": 2048 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}": { "get": { "operationId": "getProperty", "summary": "Get a property and its reporting settings", "tags": [ "Properties" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PropertyDetail" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/reports/campaigns": { "post": { "operationId": "campaignReport", "summary": "Campaign performance report", "description": "Date ranges are limited to 31 days.", "tags": [ "Reports" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "description": "Inclusive start date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "to": { "description": "Inclusive end date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "attribution": { "default": "last-ad-click", "type": "string", "enum": [ "last-ad-click", "first-ad-click" ] }, "groupBy": { "default": "campaign", "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "metrics": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 80 } }, "conversionEvents": { "description": "Defaults to the property conversion events", "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "filters": { "type": "object", "properties": { "channel": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "platform": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adNetwork": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "campaignIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adsetIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } } }, "additionalProperties": false }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "spend", "impressions", "reach", "frequency", "linkClicks", "sessions", "clients", "eventValues", "results", "resultValues", "cpm", "cpc", "ctr", "roas" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "metric" ], "additionalProperties": false }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "description": "`nextCursor` from the previous page", "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "from", "to" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReportRow" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report": { "type": "object", "properties": { "propertyId": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" }, "timezone": { "type": "string" }, "currency": { "type": "string" }, "attribution": { "type": "string", "enum": [ "last-ad-click", "first-ad-click" ] }, "groupBy": { "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "conversionEvents": { "type": "array", "items": { "type": "string" } } }, "required": [ "propertyId", "from", "to", "timezone", "currency", "attribution", "groupBy", "conversionEvents" ], "additionalProperties": false }, "summary": { "description": "Totals for the whole query; returned only on the first page", "anyOf": [ { "$ref": "#/components/schemas/CampaignReportMetrics" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor", "report", "summary" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The query timed out; narrow the date range or retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/reports/campaigns/export": { "post": { "operationId": "campaignReportExport", "summary": "Export campaign performance as CSV", "description": "Exports all matching rows without a summary, using the property time zone. Date ranges are limited to 31 days and files to 1048576 bytes. CSV columns are name, refType, refId, followed by the requested metrics.", "tags": [ "Reports" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "description": "Inclusive start date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "to": { "description": "Inclusive end date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "attribution": { "default": "last-ad-click", "type": "string", "enum": [ "last-ad-click", "first-ad-click" ] }, "groupBy": { "default": "campaign", "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "metrics": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 80 } }, "conversionEvents": { "description": "Defaults to the property conversion events", "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "filters": { "type": "object", "properties": { "channel": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "platform": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adNetwork": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "campaignIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adsetIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "adIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } } }, "additionalProperties": false }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "spend", "impressions", "reach", "frequency", "linkClicks", "sessions", "clients", "eventValues", "results", "resultValues", "cpm", "cpc", "ctr", "roas" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "metric" ], "additionalProperties": false } }, "required": [ "from", "to" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The query timed out; narrow the date range or retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/reports/events": { "post": { "operationId": "eventsReport", "summary": "Daily event counts report", "description": "Date ranges are limited to 31 days.", "tags": [ "Reports" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "description": "Inclusive start date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "to": { "description": "Inclusive end date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "eventNames": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "description": "`nextCursor` from the previous page", "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "from", "to" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventsReportRow" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report": { "type": "object", "properties": { "propertyId": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" }, "timezone": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "propertyId", "from", "to", "timezone", "currency" ], "additionalProperties": false } }, "required": [ "data", "nextCursor", "report" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The query timed out; narrow the date range or retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/reports/conversions": { "post": { "operationId": "conversionsReport", "summary": "Tracked conversion events, newest first", "description": "Returns every tracked event with its value, customer and attribution details. Date ranges are limited to 31 days.", "tags": [ "Reports" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "description": "Inclusive start date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "to": { "description": "Inclusive end date in the report time zone", "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "eventNames": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "clickId": { "description": "AnyTrack click id or client id", "type": "string", "minLength": 1, "maxLength": 256 }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "description": "`nextCursor` from the previous page", "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "from", "to" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report": { "type": "object", "properties": { "propertyId": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" }, "timezone": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "propertyId", "from", "to", "timezone", "currency" ], "additionalProperties": false } }, "required": [ "data", "nextCursor", "report" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request body too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The query timed out; narrow the date range or retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/conversions/{conversionId}": { "get": { "operationId": "getConversion", "summary": "Get a conversion event", "tags": [ "Conversions" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" }, { "in": "path", "name": "conversionId", "schema": { "description": "Conversion id", "type": "string" }, "required": true, "description": "Conversion id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Conversion" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations": { "get": { "operationId": "listIntegrations", "summary": "List the account integrations", "tags": [ "Integrations" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "propertyId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/{integrationId}": { "get": { "operationId": "getIntegration", "summary": "Get an integration", "tags": [ "Integrations" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "integrationId", "schema": { "description": "Integration id", "type": "string" }, "required": true, "description": "Integration id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/{integrationId}/logs": { "get": { "operationId": "listIntegrationLogs", "summary": "Requests received by an integration, newest first", "description": "Includes the received request parameters and the resulting event.", "tags": [ "Integrations" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "integrationId", "schema": { "description": "Integration id", "type": "string" }, "required": true, "description": "Integration id" }, { "in": "query", "name": "from", "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "in": "query", "name": "to", "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "minLength": 1, "maxLength": 2048 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationLog" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The query timed out; narrow the date range or retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/connections": { "get": { "operationId": "listConnections", "summary": "List the ad platform connections of a property", "tags": [ "Connections" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/connections/{connectionId}": { "get": { "operationId": "getConnection", "summary": "Get an ad platform connection", "tags": [ "Connections" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" }, { "in": "path", "name": "connectionId", "schema": { "description": "Connection id", "type": "string" }, "required": true, "description": "Connection id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Connection" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/destinations": { "get": { "operationId": "listDestinations", "summary": "List the pixels and ad destinations of a property", "tags": [ "Destinations" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Destination" } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/destinations/{destinationId}": { "get": { "operationId": "getDestination", "summary": "Get a pixel or ad destination", "tags": [ "Destinations" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" }, { "in": "path", "name": "destinationId", "schema": { "description": "Destination id", "type": "string" }, "required": true, "description": "Destination id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Destination" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/webhooks": { "get": { "operationId": "listWebhooks", "summary": "List the webhooks of a property", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/properties/{propertyId}/webhooks/{webhookId}": { "get": { "operationId": "getWebhook", "summary": "Get a webhook", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "propertyId", "schema": { "description": "Property id", "type": "string" }, "required": true, "description": "Property id" }, { "in": "path", "name": "webhookId", "schema": { "description": "Webhook id", "type": "string" }, "required": true, "description": "Webhook id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or deleted API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API access unavailable on the plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown or inaccessible property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded; see Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable; retry with backoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Property": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "websiteOrigin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "id", "name", "websiteOrigin", "timezone", "currency" ], "additionalProperties": false }, "PropertyDetail": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "websiteOrigin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "type": "string" }, "currency": { "type": "string" }, "reporting": { "type": "object", "properties": { "conversionEvents": { "type": "array", "items": { "type": "string" } }, "clickThroughWindowDays": { "description": "Click-through attribution window in days; null is unlimited", "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "conversionEvents", "clickThroughWindowDays" ], "additionalProperties": false } }, "required": [ "id", "name", "websiteOrigin", "timezone", "currency", "reporting" ], "additionalProperties": false }, "CampaignReportRow": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "campaign", "adset", "ad" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "adNetwork": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "paused", "terminated" ] }, { "type": "null" } ] }, "metrics": { "$ref": "#/components/schemas/CampaignReportMetrics" } }, "required": [ "id", "type", "name", "channel", "adNetwork", "status", "metrics" ], "additionalProperties": false }, "CampaignReportMetrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "EventsReportRow": { "type": "object", "properties": { "date": { "type": "string" }, "eventName": { "type": "string" }, "count": { "type": "number" } }, "required": [ "date", "eventName", "count" ], "additionalProperties": false }, "Conversion": { "type": "object", "properties": { "id": { "type": "string" }, "time": { "description": "ISO 8601 UTC timestamp", "type": "string" }, "eventName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "originalValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "originalCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transactionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clientId": { "type": "string" }, "clickId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "newSession": { "type": "boolean" }, "integrationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "label", "url" ], "additionalProperties": false }, { "type": "null" } ] }, "customer": { "anyOf": [ { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zipcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "phone", "firstName", "lastName", "city", "state", "zipcode", "country", "countryCode" ], "additionalProperties": false }, { "type": "null" } ] }, "attribution": { "description": "Attributed touchpoint", "anyOf": [ { "type": "object", "properties": { "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "adNetwork": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageVariant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clickIdParam": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clickIdValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "adset": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "ad": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "channel", "adNetwork", "source", "medium", "referrer", "pageVariant", "content", "term", "clickIdParam", "clickIdValue", "campaign", "adset", "ad" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "time", "eventName", "value", "currency", "originalValue", "originalCurrency", "transactionId", "clientId", "clickId", "newSession", "integrationId", "brand", "pageUrl", "link", "customer", "attribution" ], "additionalProperties": false }, "Integration": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "added", "active", "disabled" ] }, "provider": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "propertyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "panelUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "live": { "description": "Whether the integration received events recently", "type": "boolean" }, "eventMapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "customFields": { "description": "Non-secret settings", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "id", "name", "status", "provider", "propertyId", "panelUrl", "live", "eventMapping", "customFields" ], "additionalProperties": false }, "IntegrationLog": { "type": "object", "properties": { "id": { "type": "string" }, "receivedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "parsed", "ignored", "duplicated", "error", "unknown" ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "propertyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "event": { "anyOf": [ { "type": "object", "properties": { "eventName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "clientId": { "type": "string" }, "clickId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "eventName", "value", "clientId", "clickId" ], "additionalProperties": false }, { "type": "null" } ] }, "params": { "description": "Received request parameters", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "id", "receivedAt", "status", "message", "propertyId", "event", "params" ], "additionalProperties": false }, "Connection": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "type": "string" }, "account": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "name", "kind", "currency", "timezone", "status", "parent" ], "additionalProperties": false }, "setup": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "provisioning", "ready", "error" ] }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "status", "errorCode" ], "additionalProperties": false }, "authorizedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorizedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "destinationIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "platform", "account", "setup", "authorizedAt", "authorizedBy", "lastSyncedAt", "destinationIds", "createdAt", "updatedAt" ], "additionalProperties": false }, "Destination": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "account": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "authorized": { "type": "boolean" }, "healthy": { "type": "boolean" }, "serverEvents": { "type": "boolean" }, "serverOnly": { "type": "boolean" }, "eventMapping": { "description": "AnyTrack event name to destination event name", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "authorizedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "type", "name", "account", "enabled", "authorized", "healthy", "serverEvents", "serverOnly", "eventMapping", "authorizedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "Webhook": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "urlOrigin": { "description": "Scheme and host of the webhook URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventNames": { "type": "array", "items": { "type": "string" } }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "crossDomainPropertyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "urlOrigin", "eventNames", "version", "enabled", "healthy", "crossDomainPropertyId" ], "additionalProperties": false }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "invalid_cursor", "unauthenticated", "api_access_unavailable", "not_found", "payload_too_large", "rate_limited", "response_too_large", "upstream_timeout", "service_unavailable", "internal_error" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "retryable": { "description": "Whether retrying the request can succeed", "type": "boolean" }, "details": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } } }, "required": [ "code", "message", "requestId", "retryable" ], "additionalProperties": false }, "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": {} } } }, "required": [ "error" ], "additionalProperties": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "API key created in the dashboard (`atk_...`)" } } } }