Coda Analytics API
This API offers analytics data for your docs and Packs over time.
OpenAPI Specification
openapi: 3.0.0
info:
version: 1.5.0
title: Coda Account Analytics API
license:
name: Coda Developer Terms
url: https://coda.io/trust/developer
description: "# Introduction\n\nThe Coda API is a RESTful API that lets you programmatically interact with Coda docs:\n\n * List and search Coda docs\n * Create new docs and copy existing ones\n * Share and publish docs\n * Discover pages, tables, formulas, and controls\n * Read, insert, upsert, update, and delete rows\n\nIf you plan to integrate Coda with an AI tool, you may also want to consider using the\n[Coda MCP server](https://coda.io/resources/guides/getting_started_with_coda_mcp). It's optimized for LLM usage\npatterns and often exposes more granular methods for accessing and modifying data.\n\n# Getting Started\n\nOur [Getting Started Guide](https://coda.io/@oleg/getting-started-guide-coda-api) helps you learn the\nbasic of working with the API and shows a few ways you can use it. Check it out, and learn how to:\n\n- Read data from Coda tables and write back to them\n- Build a one-way sync from one Coda doc to another\n- Automate reminders\n- Sync your Google Calendar to Coda\n\n# Changes to the API\n\nAs we update and release newer versions of the API, we reserve the right to remove\nolder APIs and functionality with a 3-month deprecation notice. We will post about such changes as well as announce\nnew features in the [Developers Central](https://community.coda.io/c/developers-central) section of our Community,\nand update the [API updates](https://coda.io/api-updates) doc.\n\n# Using the API\n\nCoda's REST API is designed to be straightforward to use. You can use the language and platform of your choice to\nmake requests. To get a feel for the API, you can also use a tool like [Postman](https://www.getpostman.com/) or\n[Insomnia](https://insomnia.rest/).\n\n## API Endpoint\n\nThis API uses a base path of `https://coda.io/apis/v1`.\n\n## Resource IDs and Links\n\nEach resource instance retrieved via the API has the following fields:\n\n - `id`: The resource's immutable ID, which can be used to refer to it within its context\n - `type`: The type of resource, useful for identifying it in a heterogenous collection of results\n - `href`: A fully qualified URI that can be used to refer to and get the latest details on the resource\n\nMost resources can be queried by their name or ID. We recommend sticking with IDs where possible, as names are\nfragile and prone to being changed by your doc's users.\n\n### List Endpoints\n\nEndpoints supporting listing of resources have the following fields:\n\n - `items`: An array containing the listed resources, limited by the `limit` or `pageToken` query parameters\n - `nextPageLink`: If more results are available, an API link to the next page of results\n - `nextPageToken`: If more results are available, a page token that can be passed into the `pageToken` query parameter\n\n**The maximum page size may change at any time, and may be different for different endpoints.** Please do not rely on it\nfor any behavior of your application. If you pass a `limit` parameter that is larger than our maximum allowed limit,\nwe will only return as many results as our maximum limit. You should look for the presence of the `nextPageToken` on the\nresponse to see if there are more results available, rather than relying on a result set that matches your provided limit.\n\nTo fetch a subsequent page of results, pass the `pageToken` parameter. Set this parameter to the value given to you as the `nextPageToken`\nin a page response. If no value is provided, there are no more results available. You only need to pass the `pageToken` to get\nthe next page of results, you don't need to pass any of the parameters from your original request, as they are all\nimplied by the `pageToken`. Any other parameters provided alongside a `pageToken` will be ignored.\n\n### Doc IDs\n\nWhile most object IDs will have to be discovered via the API, you may find yourself frequently wanting to get the\nID of a specific Coda doc.\n\nHere's a handy tool that will extract it for you. (See if you can find the pattern!)\n\n<form>\n <fieldset style=\"margin: 0px 25px 25px 25px; display: inline;\">\n <legend>Doc ID Extractor</legend>\n <input type=\"text\" id=\"de_docUrl\" placeholder=\"Paste in a Coda doc URL\"\n style=\"width: 250px; padding: 8px; margin-right: 20px;\" />\n <span>\n Your doc ID is: \n <input id=\"de_docId\" readonly=\"true\"\n style=\"width: 150px; padding: 8px; font-family: monospace; border: 1px dashed gray;\" />\n </fieldset>\n</form>\n\n## Rate Limiting\n\nThe Coda API sets a reasonable limit on the number of requests that can be made per minute. Once this limit is\nreached, calls to the API will start returning errors with an HTTP status code of 429.\n\nThese are the current rate limits. They are subject to change at any time without notice. For robustness,\nall API scripts should check for HTTP 429 Too Many Requests errors and back off and retry the request.\nLimits apply per-user across all endpoints that share the same limit and across all docs.\n\nReading data (with the exceptions below): {{READ_RATE_LIMIT}}\n<br/>\nWriting data (POST/PUT/PATCH): {{WRITE_RATE_LIMIT}}\n<br/>\nWriting doc content data (POST/PUT/PATCH): {{WRITE_DOC_CONTENT_RATE_LIMIT}}\n<br/>\nListing docs: {{LIST_DOCS_RATE_LIMIT}}\n<br/>\nReading analytics: {{ANALYTICS_RATE_LIMIT}}\n\n## Consistency\n\nWhile edits made in Coda are shared with other collaborators in real-time, it can take a few seconds for them to\nbecome available via the API. You may also notice that changes made via the API, such as updating a row, are not\nimmediate. These endpoints all return an HTTP 202 status code, instead of a standard 200, indicating that the\nedit has been accepted and queued for processing. This generally takes a few seconds, and the edit may fail if\ninvalid. Each such edit will return a `requestId` in the response, and you can pass this `requestId` to the\n[`#getMutationStatus`](#operation/getMutationStatus) endpoint to find out if it has been applied.\n\nSimilarly, when you get doc data from the API (rows, pages, columns, etc), the data you receive comes from\nthe most recent \"snapshot\" of the doc, which might be slightly stale relative to the data you observe in\nyour browser. If you want to ensure that the data you receive is up to date and are ok getting an error if not,\nyou can pass this header in your request: `X-Coda-Doc-Version: latest`. If the API's view of the doc is\nnot up to date, the API will return an HTTP 400 response.\n\n## Volatile Formulas\n\nCoda exposes a number of \"volatile\" formulas, as as `Today()`, `Now()`, and `User()`. When used in a live Coda\ndoc, these formulas affect what's visible in realtime, tailored to the current user.\n\nSuch formulas behave differently with the API. Time-based values may only be current to the last edit made to the\ndoc. User-based values may be blank or invalid.\n\n## Free and Paid Workspaces\n\nWe make the Coda API available to all of our users free of charge, in both free and paid workspaces. However, API\nusage is subject to the role of the user associated with the API token in the workspace applicable to each API\nrequest. What this means is:\n\n- For the [`#createDoc`](#operation/createDoc) endpoint specifically, the owner of the API token must be a Doc\n Maker (or Admin) in the workspace. If the \"Any member can create docs\" option in enabled in the workspace\n settings, they can be an Editor and will get auto-promoted to Doc Maker upon using this endpoint. Lastly, if in\n addition, the API key owner matches the \"Auto-join email domains\" setting, they will be auto-added to the\n workspace and promoted to Doc Maker upon using this endpoint\n\nThis behavior applies to the API as well as any integrations that may use it, such as Zapier.\n\n## Examples\n\nTo help you get started, this documentation provides code examples in Python, Unix shell, and Google Apps Script.\nThese examples are based on a simple doc that looks something like this:\n\n\n\n### Python examples\n\nThese examples use Python 3.6+. If you don't already have the `requests` module, use `pip` or `easy_install` to\nget it.\n\n### Shell examples\n\nThe shell examples are intended to be run in a Unix shell. If you're on Windows, you will need to install\n[WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).\n\nThese examples use the standard cURL utility to pull from the API, and then process it with `jq` to extract and\nformat example output. If you don't already have it, you can either [install it](https://stedolan.github.io/jq/)\nor run the command without it to see the raw JSON output.\n\n### Google Apps Script examples\n\n\n\n[Google Apps Script](https://script.google.com/) makes it easy to write code in a JavaScript-like syntax and\neasily access many Google products with built-in libraries. You can set up your scripts to run periodically,\nwhich makes it a good environment for writing tools without maintaining your own server.\n\nCoda provides a library for Google Apps Script. To use it, go into `Resources -> Libraries...` and enter the\nfollowing library ID: `15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl`. If you want to see the\nlibrary's source code, it's available\n[here](https://script.google.com/d/15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl/edit).\n\nGoogle provides autocomplete for API functions as well as generated docs. You can access these docs via the\nLibraries dialog by clicking on the library name. Required parameters that would be included in the URL path are\npositional arguments in each of these functions, followed by the request body, if applicable. All remaining\nparameters can be specified in the options object.\n\n## OpenAPI/Swagger Spec\n\nIn an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification:\n\n- [OpenAPI 3.0 spec - YAML](https://coda.io/apis/v1/openapi.yaml)\n- [OpenAPI 3.0 spec - JSON](https://coda.io/apis/v1/openapi.json)\n\n#### Postman collection\n\nTo get started with prototyping the API quickly in Postman, you can use one of links above to import the Coda API\ninto a collection. You'll then need to set the [appropriate header](#section/Authentication) and environment\nvariables.\n\n## Client libraries\n\nWe do not currently support client libraries apart from Google Apps Script. To work with the Coda API, you can\neither use standard network libraries for your language, or use the appropriate Swagger Generator tool to\nauto-generate Coda API client libraries for your language of choice. We do not provide any guarantees that these\nautogenerated libraries are compatible with our API (e.g., some libraries may not work with Bearer\nauthentication).\n\n### OpenAPI 3.0\n\n[Swagger Generator 3](https://generator3.swagger.io/) (that link takes you to the docs for the generator API) can\ngenerate client libraries for [these languages](https://generator3.swagger.io/v2/clients). It's relatively new\nand thus only has support for a limited set of languages at this time.\n\n### Third-party client libraries\n\nSome members of our amazing community have written libraries to work with our API. These aren't officially\nsupported by Coda, but are listed here for convenience. (Please let us know if you've written a library and would\nlike to have it included here.)\n\n- [PHP](https://github.com/danielstieber/CodaPHP) by Daniel Stieber\n- [Node-RED](https://github.com/serene-water/node-red-contrib-coda-io) by Mori Sugimoto\n- [NodeJS](https://www.npmjs.com/package/coda-js) by Parker McMullin\n- [Ruby](https://rubygems.org/gems/coda_docs/) by Carlos Muñoz at Getro\n- [Python](https://github.com/Blasterai/codaio) by Mikhail Beliansky\n- [Go](https://github.com/artsafin/coda-schema-generator) by Artur Safin\n"
termsOfService: https://coda.io/trust/tos
contact:
name: API Support
url: https://coda.io
email: help+api@coda.io
x-logo:
url: https://cdn.coda.io/external/img/apilogo.png
backgroundColor: transparent
altText: Coda API
href: '#'
servers:
- url: https://coda.io/apis/v1
description: Coda API (v1)
security:
- Bearer: []
tags:
- name: Analytics
description: This API offers analytics data for your docs and Packs over time.
paths:
/analytics/docs:
get:
summary: List doc analytics
description: 'Returns analytics data for available docs per day.
'
operationId: listDocAnalytics
tags:
- Analytics
parameters:
- $ref: '#/components/parameters/docIds'
- $ref: '#/components/parameters/workspaceIdInQuery'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/isPublished'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
- $ref: '#/components/parameters/scale'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/docAnalyticsOrderBy'
- $ref: '#/components/parameters/direction'
- name: limit
description: Maximum number of results to return in this query.
in: query
example: 10
schema:
type: integer
minimum: 1
maximum: 5000
default: 1000
responses:
'200':
description: List of Coda doc analytics.
content:
application/json:
schema:
$ref: '#/components/schemas/DocAnalyticsCollection'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
x-codeSamples:
- label: Python 3.13
lang: python
source: "import requests\n\nheaders = {'Authorization': 'Bearer <your API token>'}\nuri = 'https://coda.io/apis/v1/analytics/docs'\nparams = {\n 'limit': 10,\n}\nres = requests.get(uri, headers=headers, params=params).json()\n\nprint(f'First doc is: {res[\"items\"][0][\"doc\"][\"title\"]}')\n# => First doc is: New Document\n"
- label: Shell
lang: shell
source: "curl -s -H 'Authorization: Bearer <your API token>' \\\n 'https://coda.io/apis/v1/analytics/docs' |\n jq .items[0].doc.title\n# => \"New Document\"\n"
/analytics/docs/{docId}/pages:
get:
summary: List page analytics
description: 'Returns analytics data for a given doc within the day.
This method will return a 401 if the given doc is not in an Enterprise workspace.
'
operationId: listPageAnalytics
tags:
- Analytics
parameters:
- $ref: '#/components/parameters/docId'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
- $ref: '#/components/parameters/pageToken'
- name: limit
description: Maximum number of results to return in this query.
in: query
example: 10
schema:
type: integer
minimum: 1
maximum: 5000
default: 1000
responses:
'200':
description: List of page analytics for the given Coda doc.
content:
application/json:
schema:
$ref: '#/components/schemas/PageAnalyticsCollection'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
x-codeSamples:
- label: Python 3.13
lang: python
source: "import requests\n\nheaders = {'Authorization': 'Bearer <your API token>'}\nuri = 'https://coda.io/apis/v1/analytics/docs/abcdefghi/pages'\nparams = {\n 'limit': 10,\n}\nres = requests.get(uri, headers=headers, params=params).json()\n\nprint(f'First page is: {res[\"items\"][0][\"page\"][\"name\"]}')\n# => First page is: My Page\n"
- label: Shell
lang: shell
source: "curl -s -H 'Authorization: Bearer <your API token>' \\\n 'https://coda.io/apis/v1/analytics/docs/abcdefghi/pages' |\n jq .items[0].page.name\n# => \"My Page\"\n"
/analytics/docs/summary:
get:
summary: Get doc analytics summary
description: 'Returns summarized analytics data for available docs.
'
operationId: listDocAnalyticsSummary
tags:
- Analytics
parameters:
- $ref: '#/components/parameters/isPublished'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
- $ref: '#/components/parameters/workspaceIdInQuery'
responses:
'200':
description: Response of Coda doc summary analytics.
content:
application/json:
schema:
$ref: '#/components/schemas/DocAnalyticsSummary'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
/analytics/packs:
get:
summary: List Pack analytics
description: 'Returns analytics data for Packs the user can edit.
'
operationId: listPackAnalytics
tags:
- Analytics
parameters:
- $ref: '#/components/parameters/packIds'
- $ref: '#/components/parameters/workspaceIdInQuery'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
- $ref: '#/components/parameters/scale'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/packAnalyticsOrderBy'
- $ref: '#/components/parameters/direction'
- $ref: '#/components/parameters/isPublishedNoDefault'
- name: limit
description: Maximum number of results to return in this query.
in: query
example: 10
schema:
type: integer
minimum: 1
maximum: 5000
default: 1000
responses:
'200':
description: Response of Coda Pack analytics.
content:
application/json:
schema:
$ref: '#/components/schemas/PackAnalyticsCollection'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
x-codeSamples:
- label: Python 3.13
lang: python
source: "import requests\n\nheaders = {'Authorization': 'Bearer <your API token>'}\nuri = 'https://coda.io/apis/v1/analytics/packs'\nparams = {\n 'limit': 10,\n}\nres = requests.get(uri, headers=headers, params=params).json()\n\nprint(f'First Pack is: {res[\"items\"][0][\"pack\"][\"name\"]}')\n# => First Pack is: New Pack\n"
- label: Shell
lang: shell
source: "curl -s -H 'Authorization: Bearer <your API token>' \\\n 'https://coda.io/apis/v1/analytics/packs' |\n jq .items[0].pack.name\n# => \"New Pack\"\n"
/analytics/packs/summary:
get:
summary: Get Pack analytics summary
description: 'Returns summarized analytics data for Packs the user can edit.
'
operationId: listPackAnalyticsSummary
tags:
- Analytics
parameters:
- $ref: '#/components/parameters/packIds'
- $ref: '#/components/parameters/workspaceIdInQuery'
- $ref: '#/components/parameters/isPublishedNoDefault'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
responses:
'200':
description: Response of Coda Pack summary analytics.
content:
application/json:
schema:
$ref: '#/components/schemas/PackAnalyticsSummary'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
/analytics/packs/{packId}/formulas:
get:
summary: List Pack formula analytics
description: 'Returns analytics data for Pack formulas.
'
operationId: listPackFormulaAnalytics
tags:
- Analytics
parameters:
- name: packFormulaNames
description: A list of Pack formula names (case-sensitive) for which to retrieve analytics.
in: query
explode: false
example: SquareRoot,CubeRoot
schema:
type: array
items:
type: string
- name: packFormulaTypes
description: A list of Pack formula types corresponding to the `packFormulaNames`. If specified, this must have the same length as `packFormulaNames`.
in: query
explode: false
example: action,formula
schema:
type: array
items:
$ref: '#/components/schemas/PackFormulaType'
- $ref: '#/components/parameters/packId'
- $ref: '#/components/parameters/sinceDate'
- $ref: '#/components/parameters/untilDate'
- $ref: '#/components/parameters/scale'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/packFormulaAnalyticsOrderBy'
- $ref: '#/components/parameters/direction'
- name: limit
description: Maximum number of results to return in this query.
in: query
example: 10
schema:
type: integer
minimum: 1
maximum: 5000
default: 1000
responses:
'200':
description: Response of Coda Pack formula analytics.
content:
application/json:
schema:
$ref: '#/components/schemas/PackFormulaAnalyticsCollection'
'401':
$ref: '#/components/responses/UnauthorizedError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
/analytics/updated:
get:
summary: Get analytics last updated day
description: 'Returns days based on Pacific Standard Time when analytics were last updated.
'
operationId: getAnalyticsLastUpdated
tags:
- Analytics
responses:
'200':
description: Response of analytics last updated days.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsLastUpdatedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsError'
components:
schemas:
PackAnalyticsCollection:
x-schema-name: PackAnalyticsCollection
description: List of analytics for Coda Packs over a date range.
type: object
required:
- items
additionalProperties: false
properties:
items:
type: array
items:
$ref: '#/components/schemas/PackAnalyticsItem'
nextPageToken:
$ref: '#/components/schemas/nextPageToken'
nextPageLink:
allOf:
- $ref: '#/components/schemas/nextPageLink'
- type: string
example: https://coda.io/apis/v1/analytics/packs?pageToken=xyz
PackFormulaType:
x-schema-name: PackFormulaType
type: string
enum:
- action
- formula
- sync
- metadata
x-tsEnumNames:
- Action
- Formula
- Sync
- Metadata
PackFormulaAnalyticsMetrics:
x-schema-name: PackFormulaAnalyticsMetrics
description: Analytics metrics for a Coda Pack formula.
type: object
required:
- date
- formulaInvocations
- errors
- docsActivelyUsing
- docsActivelyUsing7Day
- docsActivelyUsing30Day
- docsActivelyUsing90Day
- docsActivelyUsingAllTime
- workspacesActivelyUsing
- workspacesActivelyUsing7Day
- workspacesActivelyUsing30Day
- workspacesActivelyUsing90Day
- workspacesActivelyUsingAllTime
additionalProperties: false
properties:
date:
type: string
format: date
description: Date of the analytics data.
example: '2020-09-02'
formulaInvocations:
type: integer
description: Number of times this formula has been invoked.
example: 123
errors:
type: integer
description: Number of errors from invocations.
example: 5
medianLatencyMs:
type: integer
description: Median latency of an invocation in milliseconds. Only present for daily metrics.
example: 500
medianResponseSizeBytes:
type: integer
description: Median response size in bytes. Only present for daily metrics.
example: 300
docsActivelyUsing:
type: integer
description: Number of unique docs that have invoked a formula from this Pack in the past day.
example: 50
docsActivelyUsing7Day:
type: integer
description: Number of unique docs that have invoked a formula from this Pack in the past 7 days.
example: 100
docsActivelyUsing30Day:
type: integer
description: Number of unique docs that have invoked a formula from this Pack in the past 30 days.
example: 200
docsActivelyUsing90Day:
type: integer
description: Number of unique docs that have invoked a formula from this Pack in the past 90 days.
example: 300
docsActivelyUsingAllTime:
type: integer
description: Number of unique docs that have invoked a formula from this Pack ever.
example: 500
workspacesActivelyUsing:
type: integer
description: Number of unique workspaces that have invoked a formula from this Pack in the past day.
example: 10
workspacesActivelyUsing7Day:
type: integer
description: Number of unique workspaces that have invoked a formula from this Pack in the past 7 days.
example: 15
workspacesActivelyUsing30Day:
type: integer
description: Number of unique workspaces that have invoked a formula from this Pack in the past 30 days.
example: 20
workspacesActivelyUsing90Day:
type: integer
description: Number of unique workspaces that have invoked a formula from this Pack in the past 90 days.
example: 30
workspacesActivelyUsingAllTime:
type: integer
description: Number of unique workspaces that have invoked a formula from this Pack ever.
example: 50
workspacesActivelyTrialing:
type: integer
description: Number of unique workspaces that are currently involved in a trial.
workspacesActivelyTrialing7Day:
type: integer
description: Number of unique workspaces that have been involved in a trial in the last 7 days.
workspacesActivelyTrialing30Day:
type: integer
description: Number of unique workspaces that have been involved in a trial in the last 30 days.
workspacesActivelyTrialing90Day:
type: integer
description: Number of unique workspaces that have been involved in a trial in the last 90 days.
workspacesActivelyTrialingAllTime:
type: integer
description: Number of unique workspaces that have been involved in a trial ever.
workspacesNewlySubscribed:
type: integer
description: Number of unique workspaces that have recently subscribed to the Pack.
workspacesWithActiveSubscriptions:
type: integer
description: Number of unique workspaces that are currently subscribed to the Pack.
workspacesWithSuccessfulTrials:
type: integer
description: Number of unique workspaces that subscribed after undertaking a Pack trial.
revenueUsd:
type: string
description: Amount of revenue (in USD) that the Pack has produced.
DocAnalyticsMetrics:
x-schema-name: DocAnalyticsMetrics
description: Analytics metrics for a Coda Doc.
type: object
required:
- date
- views
- copies
- likes
- sessionsMobile
- sessionsDesktop
- sessionsOther
- totalSessions
- aiCreditsChat,
- aiCreditsBlock,
- aiCreditsColumn,
- aiCreditsAssistant,
- aiCreditsReviewer,
- aiCredits,
additionalProperties: false
properties:
date:
type: string
format: date
description: Date of the analytics data.
example: '2020-09-02'
views:
type: integer
description: Number of times the doc was viewed.
example: 980
copies:
type: integer
description: Number of times the doc was copied.
example: 24
likes:
type: integer
description: Number of times the doc was liked.
example: 342
sessionsMobile:
type: integer
description: Number of unique visitors to this doc from a mobile device.
example: 530
sessionsDesktop:
type: integer
description: Number of unique visitors to this doc from a desktop device.
example: 212
sessionsOther:
type: integer
description: Number of unique visitors to this doc from an unknown device type.
example: 10
totalSessions:
type: integer
description: Sum of the total sessions from any device.
example: 1000
aiCreditsChat:
type: integer
description: Number of credits used for AI chat.
example: 10
aiCreditsBlock:
type: integer
description: Number of credits used for AI block.
example: 10
aiCreditsColumn:
type: integer
description: Number of credits used for AI column.
example: 10
aiCreditsAssistant:
type: integer
description: Number of credits used for AI assistant.
example: 10
aiCreditsReviewer:
type: integer
description: Number of credits used for AI reviewer.
example: 10
aiCredits:
type: integer
description: Total number of AI credits used.
example: 50
DocAnalyticsSummary:
x-schema-name: DocAnalyticsSummary
description: Summarized metrics for Coda docs.
type: object
required:
- totalSessions
additionalProperties: false
properties:
totalSessions:
type: integer
description: Total number of sessions across all docs.
example: 1337
PackAnalyticsDetails:
x-schema-name: PackAnalyticsDetails
description: Metadata about a Pack relevant to analytics.
type: object
additionalProperties: false
required:
- id
- name
- createdAt
properties:
id:
type: number
description: ID of the Pack.
example: 1003
name:
type: string
description: The name of the Pack.
example: Cool Geometry Formulas
logoUrl:
type: string
format: url
description: The link to the logo of the Pack.
createdAt:
type: string
format: date-time
description: Creation time of the Pack.
example: '2022-04-11T00:18:57.946Z'
DocAnalyticsItem:
x-schema-name: DocAnalyticsItem
description: Analytics data for a Coda doc.
type: object
required:
- doc
- metrics
additionalProperties: false
properties:
doc:
$ref: '#/components/schemas/DocAnalyticsDetails'
metrics:
type: array
items:
$ref: '#/components/schemas/DocAnalyticsMetrics'
DocAnalyticsCollection:
x-schema-name: DocAnalyticsCollection
description: List of analytics for Coda docs over a date range.
type: object
required:
- items
additionalProperties: false
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocAnalyticsItem'
nextPageToken:
$ref: '#/components/schemas/nextPageToken'
nextPageLink:
allOf:
- $ref: '#/components/schemas/nextPageLink'
- type: string
example: https://coda.io/apis/v1/analytics/docs?pageToken=xyz
PackFormulaIdentifier:
x-schema-name: PackFormulaIdentifier
type: object
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coda/refs/heads/main/openapi/coda-analytics-api-openapi.yml