{"openapi":"3.1.0","info":{"title":"Apptonomy Public API","version":"1.4.0","description":"Access to an organization's Apptonomy data, and the actions that start its audits, write its draft listings for review and change its recommendations' workflow state. Authenticate with an organization API key as a bearer token. Responses are JSON with camelCase fields; identifiers are opaque strings; times are RFC 3339 UTC. Clients must ignore fields they do not know and accept enum values added later where an enum is marked extensible."},"servers":[{"url":"https://api.apptonomy.ai/v1","description":"Production"},{"url":"https://api-staging.apptonomy.ai/v1","description":"Staging"}],"security":[{"organizationApiKey":[]}],"paths":{"/openapi.json":{"get":{"operationId":"getOpenApiDocument","summary":"This document.","tags":["Meta"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/organization":{"get":{"operationId":"getOrganization","summary":"The credential's organization.","tags":["Organization"],"security":[{"organizationApiKey":["organization:read"]}],"parameters":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects":{"get":{"operationId":"listProjects","summary":"The organization's projects.","description":"Ordered by name ascending, then id.","tags":["Project"],"security":[{"organizationApiKey":["projects:read"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}":{"get":{"operationId":"getProject","summary":"One project.","tags":["Project"],"security":[{"organizationApiKey":["projects:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/audits":{"get":{"operationId":"listProjectAudits","summary":"A project's audit runs, newest first.","description":"Ordered by startedAt descending (unstarted runs first), then id.","tags":["Audit"],"security":[{"organizationApiKey":["audits:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["queued","running","completed","failed"]},"description":"Only runs in this status."},{"name":"startedAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Only runs started at or after this time."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}},"post":{"operationId":"startProjectAudit","summary":"Start an audit of one project.","description":"Queues one audit of the project for one store app and answers its operation. Refused with `409 conflict` while that store app has an unfinished audit, and with `429 quota_exceeded` when an audit was already started through the API for the project within the plan’s cadence.","tags":["Audit"],"security":[{"organizationApiKey":["audits:write"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":255},"description":"A key you choose for this request, 1 to 255 visible ASCII characters. A retry with the same key and body answers the same operation and queues nothing new; the same key with another body answers `409 idempotency_conflict`."}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAuditRequest"}}}},"responses":{"202":{"description":"Accepted: the operation, queued or already done","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/audits/{auditId}":{"get":{"operationId":"getAudit","summary":"One audit run.","tags":["Audit"],"security":[{"organizationApiKey":["audits:read"]}],"parameters":[{"name":"auditId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The audit id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/recommendations":{"get":{"operationId":"listProjectRecommendations","summary":"A project's recommendations.","description":"Ordered by createdAt descending, then id.","tags":["Recommendation"],"security":[{"organizationApiKey":["recommendations:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"auditId","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"Only recommendations this audit produced."},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","accepted","completed","dismissed","deferred","resolved","unresolved"]},"description":"Only recommendations in this workflow state; `unresolved` is `open`, `accepted` or `deferred`."},{"name":"priority","in":"query","required":false,"schema":{"type":"string","enum":["high","medium","low"]},"description":"Only recommendations of this priority."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/recommendations/{recommendationId}":{"get":{"operationId":"getRecommendation","summary":"One recommendation, with provenance.","tags":["Recommendation"],"security":[{"organizationApiKey":["recommendations:read"]}],"parameters":[{"name":"recommendationId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The recommendation id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/scores":{"get":{"operationId":"listProjectScores","summary":"A project's score history, newest first.","description":"Ordered by computedAt descending, then id.","tags":["Score"],"security":[{"organizationApiKey":["scores:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"computedAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Only scores computed at or after this time."},{"name":"computedBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Only scores computed before this time."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/scores/{scoreId}":{"get":{"operationId":"getScore","summary":"One score, with provenance.","tags":["Score"],"security":[{"organizationApiKey":["scores:read"]}],"parameters":[{"name":"scoreId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The score id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/revisions":{"get":{"operationId":"listProjectRevisions","summary":"A project's listing revisions.","description":"Ordered by revisionNumber descending, then store.","tags":["Revision"],"security":[{"organizationApiKey":["revisions:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"store","in":"query","required":false,"schema":{"type":"string","enum":["app_store","google_play"]},"description":"Only revisions for this store."},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","published","archived"]},"description":"Only revisions in this status."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevisionList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/revisions/{revisionId}":{"get":{"operationId":"getRevision","summary":"One revision.","tags":["Revision"],"security":[{"organizationApiKey":["revisions:read"]}],"parameters":[{"name":"revisionId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The revision id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevisionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/impact-results":{"get":{"operationId":"listProjectImpactResults","summary":"A project's measured revision impact results.","description":"Ordered by computedAt descending, then id.","tags":["ImpactResult"],"security":[{"organizationApiKey":["impact:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"revisionId","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"Only results for this revision."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactResultList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/impact-results/{impactResultId}":{"get":{"operationId":"getImpactResult","summary":"One impact result, with provenance.","tags":["ImpactResult"],"security":[{"organizationApiKey":["impact:read"]}],"parameters":[{"name":"impactResultId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The impact result id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactResultResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/store-analytics":{"get":{"operationId":"listProjectStoreAnalytics","summary":"Daily store-console analytics. Needs the store-analytics plan feature.","description":"Ordered by date ascending, then store, then storefront.","x-a7y-date-range":{"from":"from","to":"to","maxDays":366},"tags":["StoreAnalyticsDay"],"security":[{"organizationApiKey":["analytics:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"First day, inclusive."},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"Last day, inclusive; not before `from`, and the range spans at most 366 days."},{"name":"store","in":"query","required":false,"schema":{"type":"string","enum":["app_store","google_play"]},"description":"Only this store."},{"name":"storefront","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2}$","description":"ISO 3166-1 alpha-2 storefront code, lowercase."},"description":"Only this storefront."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreAnalyticsDayList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/proceeds":{"get":{"operationId":"listProjectProceeds","summary":"Daily proceeds. Needs `revenue:read` and the store-analytics plan feature.","description":"Ordered by date ascending, then store, then storefront, then sku.","x-a7y-date-range":{"from":"from","to":"to","maxDays":366},"tags":["ProceedsDay"],"security":[{"organizationApiKey":["revenue:read"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"First day, inclusive."},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"Last day, inclusive; not before `from`, and the range spans at most 366 days."},{"name":"store","in":"query","required":false,"schema":{"type":"string","enum":["app_store","google_play"]},"description":"Only this store."},{"name":"storefront","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2}$","description":"ISO 3166-1 alpha-2 storefront code, lowercase."},"description":"Only this storefront."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProceedsDayList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/release-notes":{"get":{"operationId":"listReleaseNotes","summary":"Apptonomy's release notes, one object per production push, newest first: the user-facing changes each push shipped. Any active key reads them; no scope is needed.","description":"Ordered by deployedAt descending, then id.","tags":["ReleaseNote"],"security":[{"organizationApiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"Page size."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512},"description":"Opaque cursor from `pagination.nextCursor` of the previous page, with the same filters."},{"name":"deployedAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Only pushes deployed at or after this time."},{"name":"deployedBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Only pushes deployed before this time."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseNoteList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/audit-batches":{"post":{"operationId":"startAuditBatch","summary":"Start audits of several projects.","description":"Queues one audit per listed project as one operation. Every item is checked before anything is queued: one refused item refuses the batch, and `details` name each such item by its index.","tags":["Audit"],"security":[{"organizationApiKey":["audits:write"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":255},"description":"A key you choose for this request, 1 to 255 visible ASCII characters. A retry with the same key and body answers the same operation and queues nothing new; the same key with another body answers `409 idempotency_conflict`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditBatchRequest"}}}},"responses":{"202":{"description":"Accepted: the operation, queued or already done","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/projects/{projectId}/revision-drafts":{"post":{"operationId":"createRevisionDraft","summary":"Write text into a store's working draft.","description":"Writes the given fields into the project's working draft for the store, for a person to review and publish in Apptonomy. Nothing is published.","tags":["Revision"],"security":[{"organizationApiKey":["revisions:write"]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The project id."},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":255},"description":"A key you choose for this request, 1 to 255 visible ASCII characters. A retry with the same key and body answers the same operation and queues nothing new; the same key with another body answers `409 idempotency_conflict`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevisionDraftRequest"}}}},"responses":{"202":{"description":"Accepted: the operation, queued or already done","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/recommendations/{recommendationId}/transitions":{"post":{"operationId":"transitionRecommendation","summary":"Change a recommendation's workflow state.","description":"Moves the recommendation — every audit observation sharing its `stableKey` — to another state, and records who, why and when. Refused with `409 conflict`: `state_changed` when `expectedVersion` is not the current `stateVersion`, `invalid_transition` when the state cannot go there, `no_stable_key` when its audit carries no stable key. Two requests at the same version: one is written, the other's item ends `failed` with `state_changed`.","tags":["Recommendation"],"security":[{"organizationApiKey":["recommendations:write"]}],"parameters":[{"name":"recommendationId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The recommendation id."},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":255},"description":"A key you choose for this request, 1 to 255 visible ASCII characters. A retry with the same key and body answers the same operation and queues nothing new; the same key with another body answers `409 idempotency_conflict`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationTransitionRequest"}}}},"responses":{"202":{"description":"Accepted: the operation, queued or already done","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/operations/{operationId}":{"get":{"operationId":"getOperation","summary":"The status of an operation an action queued.","description":"Readable with the read scope of what the operation acts on: `audits:read` for an audit start, `revisions:read` for a draft, `recommendations:read` for a transition.","tags":["Operation"],"security":[{"organizationApiKey":["audits:read"]},{"organizationApiKey":["revisions:read"]},{"organizationApiKey":["recommendations:read"]}],"parameters":[{"name":"operationId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"description":"The operation id."}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}},"components":{"schemas":{"Organization":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"name":{"type":"string","x-a7y-field":"name","x-a7y-class":"public_programmatic"},"slug":{"type":"string","x-a7y-field":"slug","x-a7y-class":"public_programmatic"},"timezone":{"type":"string","description":"IANA time zone name.","x-a7y-field":"timezone","x-a7y-class":"public_programmatic"},"iconUrl":{"type":["string","null"],"format":"uri","x-a7y-field":"iconUrl","x-a7y-class":"public_programmatic"},"createdAt":{"type":"string","format":"date-time","x-a7y-field":"createdAt","x-a7y-class":"public_programmatic"},"updatedAt":{"type":"string","format":"date-time","x-a7y-field":"updatedAt","x-a7y-class":"public_programmatic"}},"required":["id","name","slug","timezone","iconUrl","createdAt","updatedAt"],"x-a7y-resource":"organization","description":"The organization the credential belongs to."},"Project":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"organizationId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"orgId","x-a7y-class":"public_programmatic"},"name":{"type":"string","x-a7y-field":"name","x-a7y-class":"public_programmatic"},"iconUrl":{"type":["string","null"],"format":"uri","x-a7y-field":"iconUrl","x-a7y-class":"public_programmatic"},"targetLocales":{"type":"array","items":{"type":"string"},"description":"BCP 47 locale codes the project optimizes for.","x-a7y-field":"targetLocales","x-a7y-class":"public_programmatic"},"apps":{"type":"object","properties":{"appStore":{"oneOf":[{"$ref":"#/components/schemas/AppListing"},{"type":"null"}],"x-a7y-field":"asc","x-a7y-class":"public_programmatic"},"googlePlay":{"oneOf":[{"$ref":"#/components/schemas/AppListing"},{"type":"null"}],"x-a7y-field":"gpc","x-a7y-class":"public_programmatic"}},"required":["appStore","googlePlay"],"x-a7y-field":"apps","x-a7y-class":"public_programmatic"},"auditSchedule":{"oneOf":[{"$ref":"#/components/schemas/AuditSchedule"},{"type":"null"}],"x-a7y-field":"auditSchedule","x-a7y-class":"public_programmatic"},"firstAuditCompletedAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"firstAuditCompletedAt","x-a7y-class":"public_programmatic"}},"required":["id","organizationId","name","iconUrl","targetLocales","apps","auditSchedule","firstAuditCompletedAt"],"x-a7y-resource":"project","description":"A project: one product and the store apps it tracks."},"Audit":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"projectId","x-a7y-class":"public_programmatic"},"status":{"type":"string","enum":["queued","running","completed","failed"],"x-a7y-extensible-enum":true,"x-a7y-field":"status","x-a7y-class":"public_programmatic"},"storefronts":{"type":"array","items":{"type":"string","pattern":"^[a-z]{2}$","description":"ISO 3166-1 alpha-2 storefront code, lowercase."},"x-a7y-field":"storefronts","x-a7y-class":"public_programmatic"},"startedAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"startedAt","x-a7y-class":"public_programmatic"},"completedAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"completedAt","x-a7y-class":"public_programmatic"},"overallScore":{"type":["number","null"],"minimum":0,"maximum":100,"x-a7y-field":"overallScore","x-a7y-class":"public_programmatic"},"triggeredByUserId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$","description":"Needs `sensitive:read`; null for a scheduled run.","x-a7y-field":"triggeredByUserId","x-a7y-class":"sensitive"}},"required":["id","projectId","status","storefronts","startedAt","completedAt","overallScore"],"x-a7y-resource":"audit","description":"One audit run of a project and its status. `overallScore` is null until the run completes."},"Recommendation":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"auditId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"auditId","x-a7y-class":"public_programmatic"},"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"projectId","x-a7y-class":"public_programmatic"},"category":{"type":"string","x-a7y-field":"category","x-a7y-class":"public_programmatic"},"title":{"type":"string","x-a7y-field":"title","x-a7y-class":"public_programmatic"},"summary":{"type":"string","x-a7y-field":"summary","x-a7y-class":"public_programmatic"},"rationale":{"type":"string","x-a7y-field":"rationale","x-a7y-class":"public_programmatic"},"priority":{"type":"string","enum":["high","medium","low"],"x-a7y-extensible-enum":true,"x-a7y-field":"priority","x-a7y-class":"public_programmatic"},"status":{"type":"string","enum":["open","accepted","completed","dismissed","deferred","resolved"],"x-a7y-extensible-enum":true,"description":"The workflow state of the recommendation. `completed` is a recommendation marked done on an audit that carries no `stableKey`. Change it with `POST /recommendations/{recommendationId}/transitions`.","x-a7y-field":"status","x-a7y-class":"public_programmatic"},"evidence":{"type":"array","items":{"$ref":"#/components/schemas/RecommendationEvidence"},"x-a7y-field":"evidence","x-a7y-class":"public_programmatic"},"createdAt":{"type":"string","format":"date-time","x-a7y-field":"createdAt","x-a7y-class":"public_programmatic"},"dismissedByUserId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$","description":"Needs `sensitive:read`.","x-a7y-field":"dismissedByUserId","x-a7y-class":"sensitive"},"stableKey":{"type":["string","null"],"pattern":"^[0-9a-f]{16}$","description":"The same recommendation across audits of the project: every audit observation with this key shares one workflow state. Null for a recommendation from an audit that carries none; such a recommendation cannot take a transition.","x-a7y-field":"stableKey","x-a7y-class":"public_programmatic"},"stateVersion":{"type":"integer","minimum":0,"description":"The version of the workflow state, 0 before its first transition. Send it as `expectedVersion`.","x-a7y-field":"stateVersion","x-a7y-class":"public_programmatic"},"statusChangedAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"statusChangedAt","x-a7y-class":"public_programmatic"},"deferredUntil":{"type":["string","null"],"format":"date-time","description":"Set while `deferred`. A deferral past this time reads as `open`.","x-a7y-field":"deferredUntil","x-a7y-class":"public_programmatic"},"resolution":{"type":["string","null"],"description":"How a `resolved` recommendation ended: `implemented` or `no_longer_applies`; more values may be added. Null in every other state.","x-a7y-field":"resolution","x-a7y-class":"public_programmatic"}},"required":["id","auditId","projectId","category","title","summary","rationale","priority","status","evidence","createdAt","stableKey","stateVersion","statusChangedAt","deferredUntil","resolution"],"x-a7y-resource":"recommendation","description":"A recommendation an audit produced, with its evidence and its current workflow state."},"Score":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"auditId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"auditId","x-a7y-class":"public_programmatic"},"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"projectId","x-a7y-class":"public_programmatic"},"overall":{"type":"number","minimum":0,"maximum":100,"x-a7y-field":"overall","x-a7y-class":"public_programmatic"},"components":{"type":"array","items":{"$ref":"#/components/schemas/ScoreComponent"},"x-a7y-field":"components","x-a7y-class":"public_programmatic"},"method":{"type":"string","description":"How `overall` is computed, in words.","x-a7y-field":"method","x-a7y-class":"public_programmatic"},"computedAt":{"type":"string","format":"date-time","x-a7y-field":"computedAt","x-a7y-class":"public_programmatic"}},"required":["id","auditId","projectId","overall","components","method","computedAt"],"x-a7y-resource":"score","description":"One computed score of a project, from one audit. A project's scores over time are its score history."},"Revision":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"projectId","x-a7y-class":"public_programmatic"},"store":{"type":"string","enum":["app_store","google_play"],"x-a7y-extensible-enum":true,"x-a7y-field":"storeId","x-a7y-class":"public_programmatic"},"revisionNumber":{"type":"integer","minimum":1,"x-a7y-field":"revisionNumber","x-a7y-class":"public_programmatic"},"status":{"type":"string","enum":["draft","published","archived"],"x-a7y-extensible-enum":true,"x-a7y-field":"status","x-a7y-class":"public_programmatic"},"appVersion":{"type":["string","null"],"x-a7y-field":"appVersion","x-a7y-class":"public_programmatic"},"appTitle":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"appTitle","x-a7y-class":"public_programmatic"},"subtitle":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"subtitle","x-a7y-class":"public_programmatic"},"description":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"description","x-a7y-class":"public_programmatic"},"shortDescription":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"shortDescription","x-a7y-class":"public_programmatic"},"keywords":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"keywords","x-a7y-class":"public_programmatic"},"promotionalText":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"promotionalText","x-a7y-class":"public_programmatic"},"whatsNew":{"oneOf":[{"$ref":"#/components/schemas/RevisionTextField"},{"type":"null"}],"x-a7y-field":"whatsNew","x-a7y-class":"public_programmatic"},"icon":{"oneOf":[{"$ref":"#/components/schemas/RevisionIcon"},{"type":"null"}],"x-a7y-field":"icon","x-a7y-class":"public_programmatic"},"publishedAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"publishedAt","x-a7y-class":"public_programmatic"},"publishedByUserId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$","description":"Needs `sensitive:read`.","x-a7y-field":"publishedByUserId","x-a7y-class":"sensitive"},"createdAt":{"type":"string","format":"date-time","x-a7y-field":"createdAt","x-a7y-class":"public_programmatic"},"updatedAt":{"type":"string","format":"date-time","x-a7y-field":"updatedAt","x-a7y-class":"public_programmatic"}},"required":["id","projectId","store","revisionNumber","status","appVersion","appTitle","subtitle","description","shortDescription","keywords","promotionalText","whatsNew","icon","publishedAt","createdAt","updatedAt"],"x-a7y-resource":"revision","description":"A numbered listing revision for one store, in the primary locale. A field the store does not have is null."},"ImpactResult":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"projectId","x-a7y-class":"public_programmatic"},"revisionId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"revisionId","x-a7y-class":"public_programmatic"},"metric":{"type":"string","enum":["impressions","product_page_views","downloads","conversion_rate"],"x-a7y-extensible-enum":true,"x-a7y-field":"metric","x-a7y-class":"public_programmatic"},"window":{"$ref":"#/components/schemas/ImpactWindow","x-a7y-field":"window","x-a7y-class":"public_programmatic"},"baseline":{"type":["number","null"],"x-a7y-field":"baseline","x-a7y-class":"public_programmatic"},"observed":{"type":["number","null"],"x-a7y-field":"observed","x-a7y-class":"public_programmatic"},"delta":{"type":["number","null"],"x-a7y-field":"delta","x-a7y-class":"public_programmatic"},"confidence":{"type":["number","null"],"minimum":0,"maximum":1,"x-a7y-field":"confidence","x-a7y-class":"public_programmatic"},"computedAt":{"type":"string","format":"date-time","x-a7y-field":"computedAt","x-a7y-class":"public_programmatic"}},"required":["id","projectId","revisionId","metric","window","baseline","observed","delta","confidence","computedAt"],"x-a7y-resource":"impact","description":"A measured before/after result of a published revision on one metric. Values are null until the window has data."},"StoreAnalyticsDay":{"type":"object","properties":{"store":{"type":"string","enum":["app_store","google_play"],"x-a7y-extensible-enum":true,"x-a7y-field":"store","x-a7y-class":"public_programmatic"},"storefront":{"type":"string","pattern":"^[a-z]{2}$","description":"ISO 3166-1 alpha-2 storefront code, lowercase.","x-a7y-field":"storefront","x-a7y-class":"public_programmatic"},"date":{"type":"string","format":"date","x-a7y-field":"date","x-a7y-class":"public_programmatic"},"impressions":{"type":["integer","null"],"minimum":0,"x-a7y-field":"impressions","x-a7y-class":"public_programmatic"},"productPageViews":{"type":["integer","null"],"minimum":0,"x-a7y-field":"productPageViews","x-a7y-class":"public_programmatic"},"downloads":{"type":["integer","null"],"minimum":0,"x-a7y-field":"downloads","x-a7y-class":"public_programmatic"},"redownloads":{"type":["integer","null"],"minimum":0,"x-a7y-field":"redownloads","x-a7y-class":"public_programmatic"},"conversionRate":{"type":["number","null"],"minimum":0,"maximum":1,"description":"Fraction, not percent.","x-a7y-field":"conversionRate","x-a7y-class":"public_programmatic"},"uninstalls":{"type":["integer","null"],"minimum":0,"x-a7y-field":"uninstalls","x-a7y-class":"public_programmatic"},"crashes":{"type":["integer","null"],"minimum":0,"x-a7y-field":"crashes","x-a7y-class":"public_programmatic"}},"required":["store","storefront","date","impressions","productPageViews","downloads","redownloads","conversionRate","uninstalls","crashes"],"x-a7y-resource":"store_analytics","description":"One day of store-console analytics for one store and storefront. Revenue figures are served only by `/proceeds`, which carries their currency."},"ProceedsDay":{"type":"object","properties":{"store":{"type":"string","enum":["app_store","google_play"],"x-a7y-extensible-enum":true,"x-a7y-field":"store","x-a7y-class":"public_programmatic"},"storefront":{"type":"string","pattern":"^[a-z]{2}$","description":"ISO 3166-1 alpha-2 storefront code, lowercase.","x-a7y-field":"storefront","x-a7y-class":"public_programmatic"},"date":{"type":"string","format":"date","x-a7y-field":"date","x-a7y-class":"public_programmatic"},"sku":{"type":"string","x-a7y-field":"sku","x-a7y-class":"public_programmatic"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 code.","x-a7y-field":"currency","x-a7y-class":"public_programmatic"},"proceeds":{"type":"string","pattern":"^-?[0-9]+(\\.[0-9]+)?$","x-a7y-field":"proceeds","x-a7y-class":"revenue_sensitive"},"revenue":{"type":"string","pattern":"^-?[0-9]+(\\.[0-9]+)?$","x-a7y-field":"revenue","x-a7y-class":"revenue_sensitive"},"units":{"type":"integer","minimum":0,"x-a7y-field":"units","x-a7y-class":"revenue_sensitive"},"refunds":{"type":"string","pattern":"^-?[0-9]+(\\.[0-9]+)?$","description":"Refunded amount.","x-a7y-field":"refunds","x-a7y-class":"revenue_sensitive"}},"required":["store","storefront","date","sku","currency","proceeds","revenue","units","refunds"],"x-a7y-resource":"proceeds","description":"One day of proceeds for one store, storefront and SKU. Amounts are decimal strings in `currency` major units."},"ReleaseNote":{"type":"object","properties":{"id":{"type":"string","description":"The record's id: the push's version, or its date for a push recorded before contract 1.3.0.","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"version":{"type":"string","x-a7y-field":"version","x-a7y-class":"public_programmatic"},"deployedAt":{"type":"string","format":"date-time","description":"When the production deploy recorded the push. For an early push whose record was written on a later day, the start of its `date` (UTC).","x-a7y-field":"deployedAt","x-a7y-class":"public_programmatic"},"date":{"type":"string","format":"date","description":"The day of the push, UTC.","x-a7y-field":"date","x-a7y-class":"public_programmatic"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseNoteItem"},"description":"The user-facing changes, never empty.","x-a7y-field":"items","x-a7y-class":"public_programmatic"},"blogLinks":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseNoteBlogLink"},"x-a7y-field":"blogLinks","x-a7y-class":"public_programmatic"}},"required":["id","version","deployedAt","date","items","blogLinks"],"x-a7y-resource":"release_note","description":"One production push of Apptonomy and the user-facing changes it shipped. Platform-wide: the same for every organization, and the same notes as the website's release notes page."},"AppListing":{"type":"object","properties":{"storeAppId":{"type":"string","description":"App Store numeric id or Google Play package name.","x-a7y-field":"id","x-a7y-class":"public_programmatic"},"name":{"type":"string","x-a7y-field":"name","x-a7y-class":"public_programmatic"},"publisherName":{"type":"string","x-a7y-field":"publisher_name","x-a7y-class":"public_programmatic"},"iconUrl":{"type":"string","format":"uri","x-a7y-field":"icon_url_cached","x-a7y-class":"public_programmatic"},"primaryRegionCode":{"type":"string","x-a7y-field":"primary_region_code","x-a7y-class":"public_programmatic"},"primaryLanguageCode":{"type":"string","x-a7y-field":"primary_language_code","x-a7y-class":"public_programmatic"},"addedAt":{"type":"string","format":"date-time","x-a7y-field":"added_at","x-a7y-class":"public_programmatic"}},"required":["storeAppId","name","publisherName","iconUrl","primaryRegionCode","primaryLanguageCode","addedAt"],"description":"One store app a project tracks. Store credentials and permissions are never part of it."},"AuditSchedule":{"type":"object","properties":{"enabled":{"type":"boolean","x-a7y-field":"enabled","x-a7y-class":"public_programmatic"},"frequency":{"type":"string","enum":["daily","weekly","biweekly","monthly"],"x-a7y-extensible-enum":true,"x-a7y-field":"frequency","x-a7y-class":"public_programmatic"},"lastRunAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"lastRunAt","x-a7y-class":"public_programmatic"},"nextRunAt":{"type":["string","null"],"format":"date-time","x-a7y-field":"nextRunAt","x-a7y-class":"public_programmatic"},"lastAuditId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"lastAuditId","x-a7y-class":"public_programmatic"}},"required":["enabled","frequency","lastRunAt","nextRunAt","lastAuditId"]},"RecommendationEvidence":{"type":"object","properties":{"kind":{"type":"string","x-a7y-field":"kind","x-a7y-class":"public_programmatic"},"label":{"type":"string","x-a7y-field":"label","x-a7y-class":"public_programmatic"},"value":{"type":["string","number","boolean","null"],"x-a7y-field":"value","x-a7y-class":"public_programmatic"},"sourceType":{"type":"string","enum":["audit","audit_finding","recommendation","score","revision","impact_result","listing_snapshot","review"],"x-a7y-extensible-enum":true,"x-a7y-field":"sourceType","x-a7y-class":"public_programmatic"},"sourceId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","x-a7y-field":"sourceId","x-a7y-class":"public_programmatic"}},"required":["kind","label","value","sourceType","sourceId"]},"ScoreComponent":{"type":"object","properties":{"name":{"type":"string","x-a7y-field":"name","x-a7y-class":"public_programmatic"},"score":{"type":"number","x-a7y-field":"score","x-a7y-class":"public_programmatic"},"maxScore":{"type":"number","x-a7y-field":"maxScore","x-a7y-class":"public_programmatic"}},"required":["name","score","maxScore"]},"RevisionTextField":{"type":"object","properties":{"value":{"type":"string","x-a7y-field":"value","x-a7y-class":"public_programmatic"},"updatedAt":{"type":"string","format":"date-time","x-a7y-field":"updatedAt","x-a7y-class":"public_programmatic"},"source":{"type":"string","enum":["manual","content_engine","migration","api"],"x-a7y-extensible-enum":true,"x-a7y-field":"source","x-a7y-class":"public_programmatic"}},"required":["value","updatedAt","source"]},"RevisionIcon":{"type":"object","properties":{"url":{"type":"string","format":"uri","x-a7y-field":"url","x-a7y-class":"public_programmatic"},"source":{"type":"string","enum":["manual","content_engine","migration"],"x-a7y-extensible-enum":true,"x-a7y-field":"source","x-a7y-class":"public_programmatic"},"updatedAt":{"type":"string","format":"date-time","x-a7y-field":"updatedAt","x-a7y-class":"public_programmatic"}},"required":["url","source","updatedAt"]},"ImpactWindow":{"type":"object","properties":{"start":{"type":"string","format":"date","x-a7y-field":"start","x-a7y-class":"public_programmatic"},"end":{"type":"string","format":"date","x-a7y-field":"end","x-a7y-class":"public_programmatic"},"days":{"type":"integer","minimum":1,"x-a7y-field":"days","x-a7y-class":"public_programmatic"}},"required":["start","end","days"]},"ReleaseNoteItem":{"type":"object","properties":{"category":{"type":"string","enum":["new_feature","fix","improvement"],"x-a7y-extensible-enum":true,"x-a7y-field":"category","x-a7y-class":"public_programmatic"},"title":{"type":"string","x-a7y-field":"title","x-a7y-class":"public_programmatic"}},"required":["category","title"]},"ReleaseNoteBlogLink":{"type":"object","properties":{"title":{"type":"string","x-a7y-field":"title","x-a7y-class":"public_programmatic"},"url":{"type":"string","format":"uri","x-a7y-field":"url","x-a7y-class":"public_programmatic"}},"required":["title","url"]},"OrganizationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Organization"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"ProjectList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"ProjectResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Project"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"AuditList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Audit"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"AuditResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Audit"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"RecommendationList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Recommendation"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"RecommendationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Recommendation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"provenance":{"$ref":"#/components/schemas/ProvenanceBlock"}},"required":["data","meta","provenance"]},"ScoreList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Score"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"ScoreResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Score"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"provenance":{"$ref":"#/components/schemas/ProvenanceBlock"}},"required":["data","meta","provenance"]},"RevisionList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Revision"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"RevisionResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Revision"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"]},"ImpactResultList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImpactResult"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"ImpactResultResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImpactResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"provenance":{"$ref":"#/components/schemas/ProvenanceBlock"}},"required":["data","meta","provenance"]},"StoreAnalyticsDayList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StoreAnalyticsDay"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"ProceedsDayList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProceedsDay"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"ReleaseNoteList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseNote"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","pagination","meta"]},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page."},"hasMore":{"type":"boolean"}},"required":["limit","nextCursor","hasMore"]},"Freshness":{"type":"object","properties":{"asOf":{"type":["string","null"],"format":"date-time","description":"When the underlying data was last refreshed; null when never."},"consistency":{"type":"string","enum":["strong","eventual"]},"stale":{"type":"boolean","description":"True when the data is older than its refresh schedule promises."},"nextUpdateExpectedAt":{"type":["string","null"],"format":"date-time"}},"required":["asOf","consistency","stale","nextUpdateExpectedAt"]},"Warning":{"type":"object","properties":{"code":{"type":"string","enum":["partial_result","stale_data","fields_omitted"],"x-a7y-extensible-enum":true},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"`fields_omitted`: the omitted fields; empty otherwise."},"requiredScopes":{"type":"array","items":{"type":"string"},"description":"`fields_omitted`: the scopes that would return them; empty otherwise."}},"required":["code","message","fields","requiredScopes"]},"ResponseMeta":{"type":"object","properties":{"requestId":{"type":"string"},"apiVersion":{"type":"string","const":"v1"},"freshness":{"oneOf":[{"$ref":"#/components/schemas/Freshness"},{"type":"null"}]},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}},"required":["requestId","apiVersion","freshness","warnings"]},"ErrorDetail":{"type":"object","properties":{"field":{"type":["string","null"],"description":"The parameter at fault, or null for the request as a whole."},"code":{"type":"string"},"message":{"type":"string"}},"required":["field","code","message"]},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","invalid_cursor","unauthenticated","invalid_credential","forbidden","insufficient_scope","insufficient_role","grant_required","entitlement_required","organization_suspended","operation_not_enabled","not_found","method_not_allowed","not_acceptable","idempotency_conflict","conflict","rate_limited","quota_exceeded","internal_error","service_unavailable"],"x-a7y-extensible-enum":true},"message":{"type":"string","description":"Safe to show; never carries data the credential cannot read."},"requestId":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}},"required":["code","message","requestId","retryable","details"]}},"required":["error"]},"SourceLink":{"type":"object","properties":{"href":{"type":"string","format":"uri"},"path":{"type":"string"},"route":{"type":"string"},"requiresAuthentication":{"type":"boolean","const":true}},"required":["href","path","route","requiresAuthentication"]},"ProvenanceSourceRef":{"type":"object","properties":{"sourceType":{"type":"string","enum":["audit","audit_finding","recommendation","score","revision","impact_result","listing_snapshot","review"],"x-a7y-extensible-enum":true},"sourceId":{"type":"string"},"projectId":{"type":["string","null"]},"auditId":{"type":["string","null"]},"observedAt":{"type":"string","format":"date-time"},"evidenceFields":{"type":"array","items":{"type":"string"}},"availability":{"type":"string","enum":["available","archived","deleted"]},"link":{"oneOf":[{"$ref":"#/components/schemas/SourceLink"},{"type":"null"}]},"linkUnavailableReason":{"type":"string","enum":["no_exact_view","no_audit_context","invalid_identifier","source_deleted"]}},"required":["sourceType","sourceId","projectId","auditId","observedAt","evidenceFields","availability","link"]},"ProvenanceClaim":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","const":"measured"},"statement":{"type":"string"},"value":{"type":["string","number","boolean","null"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/ProvenanceSourceRef"}}},"required":["id","kind","statement","sources"]},{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","const":"derived"},"statement":{"type":"string"},"value":{"type":["string","number","boolean","null"]},"method":{"type":"string"},"inputs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":["string","number","boolean","null"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/ProvenanceSourceRef"}}},"required":["name","value","sources"]}},"coverage":{"type":"string","enum":["complete","partial"]},"missingInputs":{"type":"array","items":{"type":"string"}}},"required":["id","kind","statement","value","method","inputs","coverage","missingInputs"]},{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","const":"interpretation"},"statement":{"type":"string"},"generatedBy":{"type":"object","properties":{"kind":{"type":"string","const":"model"}},"required":["kind"]},"supportingEvidence":{"type":"array","items":{"$ref":"#/components/schemas/ProvenanceSourceRef"}}},"required":["id","kind","statement","generatedBy","supportingEvidence"]},{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","const":"unavailable"},"statement":{"type":"string"},"reason":{"type":"string","enum":["not_collected","insufficient_evidence","source_removed","source_inaccessible"]},"missing":{"type":"array","items":{"type":"string"}}},"required":["id","kind","statement","reason","missing"]}],"description":"One claim; `kind` is one of measured, derived, interpretation, unavailable."},"ProvenanceBlock":{"type":"object","properties":{"contract":{"type":"string","const":"a7y.provenance/v1"},"claims":{"type":"array","items":{"$ref":"#/components/schemas/ProvenanceClaim"}}},"required":["contract","claims"],"description":"Structured provenance (A7Y-2199): what each analytical claim rests on, with exact in-product source links."},"StartAuditRequest":{"type":"object","properties":{"store":{"type":"string","enum":["app_store","google_play"],"description":"The store app to audit. Omit it for the project’s App Store app, else its Google Play app."}},"required":[],"description":"Starts one audit of the project, for one of its store apps.","examples":[{"store":"google_play"}]},"AuditBatchItem":{"type":"object","properties":{"projectId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"store":{"type":"string","enum":["app_store","google_play"],"description":"The store app to audit. Omit it for the project’s App Store app, else its Google Play app."}},"required":["projectId"]},"AuditBatchRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AuditBatchItem"},"minItems":1,"maxItems":100,"description":"One item per project, each project at most once. A plan admits fewer items than the maximum; the refusal names its limit."}},"required":["items"],"examples":[{"items":[{"projectId":"proj_edutravel"},{"projectId":"proj_edutravel_play","store":"google_play"}]}]},"RevisionDraftFields":{"type":"object","properties":{"appTitle":{"type":"string","minLength":1,"maxLength":30},"subtitle":{"type":"string","minLength":1,"maxLength":30},"description":{"type":"string","minLength":1,"maxLength":4000},"shortDescription":{"type":"string","minLength":1,"maxLength":80},"keywords":{"type":"string","minLength":1,"maxLength":100},"promotionalText":{"type":"string","minLength":1,"maxLength":170},"whatsNew":{"type":"string","minLength":1,"maxLength":4000}},"required":[],"description":"At least one field. Each store takes its own fields and limits: App Store `appTitle`, `subtitle`, `keywords`, `promotionalText`, `description`, `whatsNew`; Google Play `appTitle`, `shortDescription`, `description`, `whatsNew`."},"BaseRevision":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","updatedAt"],"description":"The working draft as you last read it (`GET /revisions/{revisionId}`). If it has changed since, the request answers `409 conflict` and writes nothing. A change made while the write is in flight is not overwritten either: the operation's item ends `failed` with `draft_changed`."},"RevisionDraftRequest":{"type":"object","properties":{"store":{"type":"string","enum":["app_store","google_play"]},"fields":{"$ref":"#/components/schemas/RevisionDraftFields"},"recommendationId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","description":"The accepted recommendation the text implements; recorded on the draft."},"baseRevision":{"$ref":"#/components/schemas/BaseRevision"}},"required":["store","fields"],"description":"Writes text into the store's working draft, creating it when there is none. A person reviews and publishes the draft in Apptonomy.","examples":[{"store":"app_store","fields":{"subtitle":"Geography games for kids"},"recommendationId":"6175645f323032365f31305f32332f7375627469746c655f73776170","baseRevision":{"id":"proj_edutravel_appstore_4","updatedAt":"2026-11-17T11:00:00.000Z"}}]},"RecommendationTransitionRequest":{"type":"object","properties":{"to":{"type":"string","enum":["open","accepted","deferred","resolved","dismissed"],"description":"The state to move the recommendation to."},"expectedVersion":{"type":"integer","minimum":0,"description":"The `stateVersion` you read. If the state has changed since, the request answers `409 conflict` with `state_changed` and writes nothing."},"reason":{"type":"string","minLength":1,"maxLength":500,"description":"Why, recorded with the transition."},"deferredUntil":{"type":"string","format":"date-time","description":"Required with `to: deferred`: when to look at it again, in the future, at most a year ahead."},"resolution":{"type":"string","enum":["implemented","no_longer_applies"],"description":"With `to: resolved`: how it ended. Defaults to `implemented`."},"draftRevisionId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$","description":"A revision of the same project that carries the work, recorded with the transition."}},"required":["to","expectedVersion"],"description":"Moves a recommendation to another workflow state. The state is the recommendation’s across every audit that observed it (its `stableKey`). Allowed: from `open`, `accepted` or `deferred` to any other state; from `resolved` or `dismissed` back to `open`. Asking for the state it is already in writes nothing: the operation’s item ends `skipped` with `no_change`.","examples":[{"to":"accepted","expectedVersion":0,"reason":"Doing this in the November release."},{"to":"deferred","expectedVersion":1,"deferredUntil":"2027-01-15T00:00:00.000Z"}]},"Operation":{"type":"object","properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"},"type":{"type":"string","description":"`audit.start`, `revision.draft` or `recommendation.transition`."},"state":{"type":"string","enum":["submitted","working","input_required","auth_required","completed","failed","cancelled","rejected"],"x-a7y-extensible-enum":true},"taskState":{"type":"string","enum":["working","input_required","completed","failed","cancelled"],"x-a7y-extensible-enum":true,"description":"The same state in MCP task terms."},"progress":{"type":"number","minimum":0,"maximum":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/OperationItem"}},"resultResourceIds":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,128}$"}},"error":{"oneOf":[{"$ref":"#/components/schemas/OperationError"},{"type":"null"}]},"retry":{"type":"string","enum":["retry_with_new_key","do_not_retry","none"],"x-a7y-extensible-enum":true},"cancelRequested":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"endedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","type","state","taskState","progress","items","resultResourceIds","error","retry","cancelRequested","createdAt","updatedAt","startedAt","endedAt"],"description":"`completed` means every item reached its end: for an audit start, that the audit was started — follow the audit itself at `GET /audits/{auditId}`."},"OperationItem":{"type":"object","properties":{"targetId":{"type":"string"},"projectId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$"},"state":{"type":"string","enum":["pending","completed","failed","skipped"],"x-a7y-extensible-enum":true},"resultResourceId":{"type":["string","null"],"pattern":"^[A-Za-z0-9_-]{1,128}$","description":"What the item produced (an audit id, a revision id, a recommendation id), or the running audit a skipped item found."},"errorCode":{"type":["string","null"]}},"required":["targetId","projectId","state","resultResourceId","errorCode"]},"OperationError":{"type":"object","properties":{"code":{"type":"string","enum":["authorization_revoked","worker_lost","queue_timeout","execution_failed"],"x-a7y-extensible-enum":true},"message":{"type":"string"}},"required":["code","message"]},"OperationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Operation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"examples":[{"data":{"id":"op_8h2k4m6p9r1t3v5x7z0b2d4f","type":"audit.start","state":"submitted","taskState":"working","progress":0,"items":[{"targetId":"proj_edutravel","projectId":"proj_edutravel","state":"pending","resultResourceId":null,"errorCode":null}],"resultResourceIds":[],"error":null,"retry":"none","cancelRequested":false,"createdAt":"2026-11-17T12:00:00.000Z","updatedAt":"2026-11-17T12:00:00.000Z","startedAt":null,"endedAt":null},"meta":{"requestId":"req_Xq2aB7cD9eF1gH3iJ5kL7mN9","apiVersion":"v1","freshness":null,"warnings":[]}},{"data":{"id":"op_3c5e7g9i1k3m5o7q9s1u3w5y","type":"audit.start","state":"completed","taskState":"completed","progress":1,"items":[{"targetId":"proj_edutravel","projectId":"proj_edutravel","state":"completed","resultResourceId":"aud_2026_11_17_a","errorCode":null},{"targetId":"proj_edutravel_play","projectId":"proj_edutravel_play","state":"skipped","resultResourceId":"aud_2026_11_17_b","errorCode":"audit_in_progress"}],"resultResourceIds":["aud_2026_11_17_a","aud_2026_11_17_b"],"error":null,"retry":"none","cancelRequested":false,"createdAt":"2026-11-17T12:00:00.000Z","updatedAt":"2026-11-17T12:00:00.000Z","startedAt":"2026-11-17T12:00:01.000Z","endedAt":"2026-11-17T12:00:03.000Z"},"meta":{"requestId":"req_Xq2aB7cD9eF1gH3iJ5kL7mN9","apiVersion":"v1","freshness":null,"warnings":[]}},{"data":{"id":"op_5d7f9h1j3l5n7p9r1t3v5x7z","type":"revision.draft","state":"completed","taskState":"completed","progress":1,"items":[{"targetId":"proj_edutravel","projectId":"proj_edutravel","state":"completed","resultResourceId":"proj_edutravel_appstore_4","errorCode":null}],"resultResourceIds":["proj_edutravel_appstore_4"],"error":null,"retry":"none","cancelRequested":false,"createdAt":"2026-11-17T12:00:00.000Z","updatedAt":"2026-11-17T12:00:00.000Z","startedAt":"2026-11-17T12:00:00.000Z","endedAt":"2026-11-17T12:00:00.000Z"},"meta":{"requestId":"req_Xq2aB7cD9eF1gH3iJ5kL7mN9","apiVersion":"v1","freshness":null,"warnings":[]}},{"data":{"id":"op_7f9h1j3l5n7p9r1t3v5x7z9b","type":"recommendation.transition","state":"completed","taskState":"completed","progress":1,"items":[{"targetId":"6175645f323032365f31305f32332f7375627469746c655f73776170","projectId":"proj_edutravel","state":"completed","resultResourceId":"6175645f323032365f31305f32332f7375627469746c655f73776170","errorCode":null}],"resultResourceIds":["6175645f323032365f31305f32332f7375627469746c655f73776170"],"error":null,"retry":"none","cancelRequested":false,"createdAt":"2026-11-17T12:00:00.000Z","updatedAt":"2026-11-17T12:00:00.000Z","startedAt":"2026-11-17T12:00:00.000Z","endedAt":"2026-11-17T12:00:00.000Z"},"meta":{"requestId":"req_Xq2aB7cD9eF1gH3iJ5kL7mN9","apiVersion":"v1","freshness":null,"warnings":[]}},{"data":{"id":"op_3c5e7g9i1k3m5o7q9s1u3w5y","type":"audit.start","state":"completed","taskState":"completed","progress":1,"items":[{"targetId":"proj_edutravel","projectId":"proj_edutravel","state":"completed","resultResourceId":"aud_2026_11_17_a","errorCode":null},{"targetId":"proj_edutravel_play","projectId":"proj_edutravel_play","state":"skipped","resultResourceId":"aud_2026_11_17_b","errorCode":"audit_in_progress"}],"resultResourceIds":["aud_2026_11_17_a","aud_2026_11_17_b"],"error":null,"retry":"none","cancelRequested":false,"createdAt":"2026-11-17T12:00:00.000Z","updatedAt":"2026-11-17T12:00:00.000Z","startedAt":"2026-11-17T12:00:01.000Z","endedAt":"2026-11-17T12:00:03.000Z"},"meta":{"requestId":"req_Xq2aB7cD9eF1gH3iJ5kL7mN9","apiVersion":"v1","freshness":null,"warnings":[]}}]}},"responses":{"BadRequest":{"description":"`invalid_request` or `invalid_cursor`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"`unauthenticated` or `invalid_credential`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"`insufficient_scope`, `entitlement_required`, `organization_suspended`, `operation_not_enabled` or `forbidden`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"`not_found`: missing, or not available to this credential.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"`conflict` or `idempotency_conflict`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"`rate_limited` or `quota_exceeded`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalError":{"description":"`internal_error`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServiceUnavailable":{"description":"`service_unavailable`.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"headers":{"RequestId":{"description":"Unique id of this request; quote it to support.","schema":{"type":"string"}},"Location":{"description":"The operation this request queued: `GET` it for its status.","schema":{"type":"string"}},"RetryAfter":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":0}},"RateLimit":{"description":"Remaining quota and reset of the policy that applies (IETF RateLimit header fields).","schema":{"type":"string"}},"RateLimitPolicy":{"description":"The rate-limit policies that apply to this credential.","schema":{"type":"string"}}},"securitySchemes":{"organizationApiKey":{"type":"http","scheme":"bearer","description":"An organization API key (`Authorization: Bearer a7y_live_…`) created in Org Settings → API Access. It acts for the organization, never for a user, and carries explicit read scopes. Keys are never accepted in a URL."}}},"x-a7y-reserved":{"idempotencyHeader":"Idempotency-Key","operationsPath":"/operations/{operationId}","deprecationHeaders":["Deprecation","Sunset"]}}