Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Highseat","colors":{"primary":"#266ea4","light":"#599fd8","dark":"#266ea4"},"logo":{"light":"https://mintcdn.com/highseat/uRXuNE4BQvZCBIJg/logo/wordmark-ink.svg?fit=max\u0026auto=format\u0026n=uRXuNE4BQvZCBIJg\u0026q=85\u0026s=37c09bc6651848a6860de2941f455c61","dark":"https://mintcdn.com/highseat/uRXuNE4BQvZCBIJg/logo/wordmark-paper.svg?fit=max\u0026auto=format\u0026n=uRXuNE4BQvZCBIJg\u0026q=85\u0026s=31aeb0f3c08cebe2f8929fbc94216891","href":"https://highseat.com"},"favicon":"https://mintcdn.com/highseat/KaJUuFS6_d4OcHrk/favicon.svg?fit=max\u0026auto=format\u0026n=KaJUuFS6_d4OcHrk\u0026q=85\u0026s=7b355c5486dc0103697178480d1b0c3e","api":{"playground":{"proxy":false}},"background":{"color":{"light":"#fbfaf9","dark":"#1b1a18"}},"navbar":{"primary":{"type":"button","label":"Sign in","href":"https://app.highseat.com"}},"footer":{"socials":{"website":"https://highseat.com","x":"https://x.com/highseathq","github":"https://github.com/highseat","linkedin":"https://www.linkedin.com/company/highseathq","bluesky":"https://bsky.app/profile/highseat.com"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"highseat","hasAudioNarration":false,"actualSubdomain":"highseat","customDomains":["highseat.com"],"gitSource":{"type":"github","owner":"highseat","repo":"highseat","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6add303ab15e1796283b83e8","collectionId":"71222fd6-d044-458b-93cb-3c72d2ab3c77","liveDeploymentHistoryId":"6add303ab15e1796283b83e8","schemaVersion":"v3"},"entitlements":{},"buildId":"6add303ab15e1796283b83e8","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":53},{"language":"default","tag":"Endpoints","count":49},{"language":"default","tag":"Documentation","count":19},{"language":"default","tag":"Stats","count":16},{"language":"default","tag":"Sites","count":7},{"language":"default","tag":"Install","count":6},{"language":"default","tag":"First-party proxy","count":6},{"language":"default","tag":"Funnels","count":6},{"language":"default","tag":"Reports","count":6},{"language":"default","tag":"Goals","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/notes/create-a-note","slug":"/api/notes/create-a-note","pageMetadata":{"title":"Create a note","description":"Pins a note to a day of the site's chart, as the dashboard does. The API key is its author, and the chart names it.","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/notes","href":"/api/notes/create-a-note","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Pins a note to a day of the site’s chart, as the dashboard does. The API key is its author, and the chart names it.\"\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":{"config":{},"pageMetadata":{"title":"Create a note","description":"Pins a note to a day of the site's chart, as the dashboard does. The API key is its author, and the chart names it.","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/notes","href":"/api/notes/create-a-note","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createNote","summary":"Create a note","description":"Pins a note to a day of the site's chart, as the dashboard does. The API key is its author, and the chart names it.","tags":["Notes"],"requestBody":"efce4d19-d30d-4a24-a1ad-b588924521d4","parameters":["d0019af8-6014-4866-899b-581aa768ba5e","44a84908-d3b5-4a6c-ae69-030db6a3c432"],"responses":{"201":"c9d3444b-5bda-47f6-ac40-044a7770d31c","400":"6c4fbaad-d823-45e3-aca3-b8be0ca705f8","401":"285e0115-439a-48c6-a773-22ce501e56b1","403":"e534a2f2-29d4-418f-b517-b80dc77b55a6","404":"f4ea2b63-035e-4382-a941-469bec63ae3f","409":"09e865be-bb2c-4def-8b82-841dc3ad7c54","413":"e61dfcd8-7920-4a01-9c71-290f9053ecc7","422":"c7d70e92-7e26-4fc3-a4d6-16ec0827f3ca","429":"6ccdb51c-27fa-4cd1-a63c-5e33f7faec4c","503":"72b3ff6e-258a-4565-9df8-877fa411ecb1"},"method":"post","type":"path","servers":["40c6e23b-3ec1-4e2d-adc4-ac80c8cd0559"],"security":["ecd990a2-5dcb-45ad-add4-ee3f2e9a93d9"],"path":"/sites/{site}/notes","baseUrlOptions":["https://api.highseat.com/v1"],"title":"Create a note","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"d0019af8-6014-4866-899b-581aa768ba5e":{"name":"site","in":"path","required":true,"schema":{"type":"string","description":"The site: its domain as registered (example.com), or its site id.","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"44a84908-d3b5-4a6c-ae69-030db6a3c432":{"name":"Idempotency-Key","in":"header","required":false,"description":"Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","minLength":1,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","isRequired":true,"uniqueKey":"date","typeLabel":"string"},"text":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"text","typeLabel":"string"}},"required":["date","text"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"date":"\u003cstring>","text":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c9d3444b-5bda-47f6-ac40-044a7770d31c":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"date":{"type":"string","description":"The day the note is pinned to on the chart, YYYY-MM-DD.","isRequired":true,"uniqueKey":"data.date","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.text","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"createdBy":{"oneOf":[{"type":"object","description":"Who wrote the note: a person, or the API key that created it. An edit keeps the author. Null once the author is deleted.","required":["name"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"data.createdBy.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.createdBy.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who wrote the note: a person, or the API key that created it. An edit keeps the author. Null once the author is deleted.","isRequired":true,"uniqueKey":"data.createdBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.createdBy","typeLabel":"object | null"}},"required":["id","date","text","createdAt","updatedAt","createdBy"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","date":"\u003cstring>","text":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","createdBy":{"name":"\u003cstring>"}}}}},"exampleType":"generated"}},"headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"exampleType":"generated"},"6c4fbaad-d823-45e3-aca3-b8be0ca705f8":{"description":"The request is malformed, or its Idempotency-Key is not 1 to 255 characters: BAD_REQUEST.","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"285e0115-439a-48c6-a773-22ce501e56b1":{"description":"No API key, or one that is not valid: UNAUTHORIZED.","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e534a2f2-29d4-418f-b517-b80dc77b55a6":{"description":"The key can only read (KEY_READ_ONLY), or the workspace is closed until it pays and takes no changes (FORBIDDEN).","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"f4ea2b63-035e-4382-a941-469bec63ae3f":{"description":"The site, the row the path names or the route does not exist: NOT_FOUND.","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"09e865be-bb2c-4def-8b82-841dc3ad7c54":{"description":"The change conflicts with a row that exists (CONFLICT, or the write's own code, which carries the row's `id`), or a request with the same Idempotency-Key still runs (IDEMPOTENCY_KEY_IN_USE).","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e61dfcd8-7920-4a01-9c71-290f9053ecc7":{"description":"The body is over 1 MB: PAYLOAD_TOO_LARGE.","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"c7d70e92-7e26-4fc3-a4d6-16ec0827f3ca":{"description":"The Idempotency-Key was sent with another request in the last 24 hours (IDEMPOTENCY_KEY_REUSED), or the site already has as many rows of this kind as it may save (the write's own code, such as GOAL_LIMIT_REACHED).","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6ccdb51c-27fa-4cd1-a63c-5e33f7faec4c":{"description":"The key has used its hourly budget (RATE_LIMITED), or its workspace already runs as many calls at once as it may (TOO_MANY_CONCURRENT_REQUESTS).","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before the next call.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"72b3ff6e-258a-4565-9df8-877fa411ecb1":{"description":"The server is busy; retry in a moment: SERVICE_UNAVAILABLE.","headers":{"RateLimit-Limit":{"description":"Calls the key may make in the window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Calls left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window reopens.","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The quota and window, as the IETF draft writes it: \"hourly\";q=600;w=3600.","schema":{"type":"string"}},"RateLimit":{"description":"The remaining budget, as the IETF draft writes it: \"hourly\";r=599;t=3540.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added, never renamed.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"What went wrong, written for a person.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"id":{"type":"string","description":"On a conflict, the existing row's id, so a client can update it instead.","uniqueKey":"error.id","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"description":"The parameter at fault, e.g. ['filter', 1] for the second filter.","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"(string | number)[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"description":"One entry per invalid parameter.","uniqueKey":"error.issues","typeLabel":"object[]"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","id":"\u003cstring>","issues":[{"path":["\u003cstring>"],"message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ecd990a2-5dcb-45ad-add4-ee3f2e9a93d9":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"40c6e23b-3ec1-4e2d-adc4-ac80c8cd0559":{"url":"https://api.highseat.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.highseat.com/v1/openapi.json"},"subdomain":"highseat","siteName":"Highseat","title":"Create a note - Highseat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T21:13:38.758Z","originalFileLocation":"api/notes/create-a-note.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=\"system\"}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=\"Pins a note to a day of the site\u0026#x27;s chart, as the dashboard does. The API key is its author, and the chart names it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Highseat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_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=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a note - Highseat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pins a note to a day of the site\u0026#x27;s chart, as the dashboard does. The API key is its author, and the chart names it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Highseat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://highseat.com/docs/api/notes/create-a-note\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://highseat.mintlify.app/_mintlify/api/og/v2?division=Notes\u0026amp;title=Create+a+note\u0026amp;description=Pins+a+note+to+a+day+of+the+site%27s+chart%2C+as+the+dashboard+does.+The+API+key+is+its+author%2C+and+the+chart+names+it.\u0026amp;theme=004992e464dd97e45470fd4c\u0026amp;signature=889427e28dfe7790f17557179773bca0d998b4da234aba4da6fd0763aba94a4c\">\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=\"Create a note - Highseat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pins a note to a day of the site\u0026#x27;s chart, as the dashboard does. The API key is its author, and the chart names it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://highseat.mintlify.app/_mintlify/api/og/v2?division=Notes\u0026amp;title=Create+a+note\u0026amp;description=Pins+a+note+to+a+day+of+the+site%27s+chart%2C+as+the+dashboard+does.+The+API+key+is+its+author%2C+and+the+chart+names+it.\u0026amp;theme=004992e464dd97e45470fd4c\u0026amp;signature=889427e28dfe7790f17557179773bca0d998b4da234aba4da6fd0763aba94a4c\">\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=\"/docs/mintlify-assets/_mintlify/favicons/highseat/OsP-7GcMYI4EfJ5-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Highseat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#266ea4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://highseat.com/docs/api/notes/create-a-note\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/notes/create-a-note.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://highseat.com/#organization\",\"name\":\"Highseat\",\"url\":\"https://highseat.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/highseat/uRXuNE4BQvZCBIJg/logo/wordmark-ink.svg?fit=max\u0026auto=format\u0026n=uRXuNE4BQvZCBIJg\u0026q=85\u0026s=37c09bc6651848a6860de2941f455c61\"}},{\"@type\":\"WebSite\",\"@id\":\"https://highseat.com/docs#website\",\"name\":\"Highseat\",\"url\":\"https://highseat.com/docs\",\"publisher\":{\"@id\":\"https://highseat.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://highseat.com/docs/api/notes/create-a-note#webpage\",\"url\":\"https://highseat.com/docs/api/notes/create-a-note\",\"name\":\"Create a note\",\"description\":\"Pins a note to a day of the site's chart, as the dashboard does. The API key is its author, and the chart names it.\",\"dateModified\":\"2026-10-24T21:13:38.758Z\",\"isPartOf\":{\"@id\":\"https://highseat.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://highseat.com/docs/api/notes/create-a-note#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://highseat.com/docs/api/notes/create-a-note#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://highseat.com/docs/api/key/describe-the-api-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Notes\",\"item\":\"https://highseat.com/docs/api/notes/list-notes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a note\",\"item\":\"https://highseat.com/docs/api/notes/create-a-note\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://highseat.com/docs/api/notes/create-a-note#apireference\",\"headline\":\"Create a note\",\"name\":\"Create a note\",\"description\":\"Pins a note to a day of the site's chart, as the dashboard does. The API key is its author, and the chart names it.\",\"url\":\"https://highseat.com/docs/api/notes/create-a-note\",\"mainEntityOfPage\":{\"@id\":\"https://highseat.com/docs/api/notes/create-a-note#webpage\"},\"dateModified\":\"2026-10-24T21:13:38.758Z\",\"publisher\":{\"@id\":\"https://highseat.com/#organization\"},\"isPartOf\":{\"@id\":\"https://highseat.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Highseat\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Highseat","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Highseat API","pages":[{"title":"Introduction","href":"/api"},{"title":"Authentication","href":"/api/authentication"},{"title":"Limits","href":"/api/limits"},{"title":"MCP server","href":"/api/mcp"}]},{"group":"Endpoints","pages":[{"group":"Key","pages":[{"title":"Describe the API key","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /key","href":"/api/key/describe-the-api-key"}]},{"group":"Sites","pages":[{"title":"List sites","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites","href":"/api/sites/list-sites"},{"title":"Create a site","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites","href":"/api/sites/create-a-site"},{"title":"Get a site","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}","href":"/api/sites/get-a-site"},{"title":"Update a site","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json patch /sites/{site}","href":"/api/sites/update-a-site"},{"title":"Change the reporting currency","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json put /sites/{site}/reporting-currency","href":"/api/sites/change-the-reporting-currency"},{"title":"Create the site secret","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/secret","href":"/api/sites/create-the-site-secret"},{"title":"Get the install status","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/install","href":"/api/sites/get-the-install-status"}]},{"group":"Discovery","pages":[{"title":"Get a dimension's values","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/filter-values/{dimension}","href":"/api/discovery/get-a-dimensions-values"},{"title":"Get the pages or events ever sent","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/catalog/{kind}","href":"/api/discovery/get-the-pages-or-events-ever-sent"}]},{"group":"Stats","pages":[{"title":"Visitors online now","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/realtime","href":"/api/stats/visitors-online-now"},{"title":"Headline figures","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/overview","href":"/api/stats/headline-figures"},{"title":"Figures per time bucket","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/timeseries","href":"/api/stats/figures-per-time-bucket"},{"title":"Pages","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/pages","href":"/api/stats/pages"},{"title":"Traffic sources","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/sources","href":"/api/stats/traffic-sources"},{"title":"Browsers, operating systems and device types","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/devices","href":"/api/stats/browsers-operating-systems-and-device-types"},{"title":"Countries, regions and cities","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/locations","href":"/api/stats/countries-regions-and-cities"},{"title":"UTM campaigns","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/campaigns","href":"/api/stats/utm-campaigns"},{"title":"Custom events","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/events","href":"/api/stats/custom-events"},{"title":"One custom event","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/events/{name}","href":"/api/stats/one-custom-event"},{"title":"Bot traffic","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/bots","href":"/api/stats/bot-traffic"},{"title":"Goal conversions","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/goals/conversions","href":"/api/stats/goal-conversions"},{"title":"Revenue totals","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/revenue","href":"/api/stats/revenue-totals"},{"title":"Revenue by product","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/revenue/products","href":"/api/stats/revenue-by-product"},{"title":"Attributed revenue","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/revenue/attribution","href":"/api/stats/attributed-revenue"},{"title":"Event properties","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/properties","href":"/api/stats/event-properties"}]},{"group":"Usage","pages":[{"title":"Get the event usage","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /usage","href":"/api/usage/get-the-event-usage"}]},{"group":"Notes","pages":[{"title":"List notes","description":"The notes pinned to the site's chart, newest first: the dashboard's own. `from` and `to` keep the notes of those days. A list: `{ data, nextCursor }`. Walk it by passing `nextCursor` as `cursor`; the last page answers `nextCursor: null`. Reuse a cursor only with the same parameters.","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/notes","href":"/api/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/notes","href":"/api/notes/create-a-note"},{"title":"Get a note","description":"One note of the site, by its id.","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/notes/{id}","href":"/api/notes/get-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json delete /sites/{site}/notes/{id}","href":"/api/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json patch /sites/{site}/notes/{id}","href":"/api/notes/update-a-note"}]},{"group":"Goals","pages":[{"title":"List goals","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/goals","href":"/api/goals/list-goals"},{"title":"Create a goal","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/goals","href":"/api/goals/create-a-goal"},{"title":"Get a goal","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/goals/{id}","href":"/api/goals/get-a-goal"},{"title":"Delete a goal","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json delete /sites/{site}/goals/{id}","href":"/api/goals/delete-a-goal"},{"title":"Update a goal","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json patch /sites/{site}/goals/{id}","href":"/api/goals/update-a-goal"}]},{"group":"Funnels","pages":[{"title":"List saved funnels","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/funnels","href":"/api/funnels/list-saved-funnels"},{"title":"Create a funnel","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/funnels","href":"/api/funnels/create-a-funnel"},{"title":"Evaluate a saved funnel","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/funnels/{id}","href":"/api/funnels/evaluate-a-saved-funnel"},{"title":"Delete a funnel","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json delete /sites/{site}/funnels/{id}","href":"/api/funnels/delete-a-funnel"},{"title":"Update a funnel","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json patch /sites/{site}/funnels/{id}","href":"/api/funnels/update-a-funnel"},{"title":"Evaluate unsaved funnel steps","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/funnel-preview","href":"/api/funnels/evaluate-unsaved-funnel-steps"}]},{"group":"Reports","pages":[{"title":"List saved reports","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/reports","href":"/api/reports/list-saved-reports"},{"title":"Create a saved report","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json post /sites/{site}/reports","href":"/api/reports/create-a-saved-report"},{"title":"Get a saved report","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/reports/{id}","href":"/api/reports/get-a-saved-report"},{"title":"Delete a saved report","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json delete /sites/{site}/reports/{id}","href":"/api/reports/delete-a-saved-report"},{"title":"Update a saved report","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json patch /sites/{site}/reports/{id}","href":"/api/reports/update-a-saved-report"},{"title":"Get a saved report's figures","deprecated":null,"version":null,"openapi":"https://api.highseat.com/v1/openapi.json get /sites/{site}/reports/{id}/results","href":"/api/reports/get-a-saved-reports-figures"}]}]}]}]},"title":"Create a note - Highseat","buildId":"dpl_BvXubCjoPYfvfFiCP5WgKvGYUZ9k","deploymentId":"dpl_BvXubCjoPYfvfFiCP5WgKvGYUZ9k","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Cn24bQ-L.js","utils-2fswSlDf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CCIi4ABW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CAH7N_Ow.js","snippetPresets-x_0VpYAk.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-llGafAZf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-W1eCShSz.js","shallow-NLT_NnDI.js","getApiPlaygroundDisplay-QSEhtcdZ.js","CodeSnippet-CK8Lk0kg.js","CodeSnippets-Cra_whAm.js","Page-CQfXSH2v.js","getPastedJson-BEz4UfPL.js","icon-CwvrEduL.js","MethodPill-DblyOGAG.js","DuplicateIcon-7P7ixz4I.js","createIcon-BURR5_pt.js","DynamicMarkdown-DteaQut7.js","SectionHeading-CHtmkzk7.js","axios-vUo_bRtp.js","Markdown-BIU4AXHQ.js","clsx-Ds0AvV0Z.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Ka3QKbKd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BURaoZsB.js"]}