Coda

List doc analytics

开发环境

http://dev-cn.your-api-server.com

GET

/analytics/docs

Analytics

Returns analytics data for available docs per day.

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "doc": {
                "id": "AbCDeFGH",
                "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
                "browserLink": "https://coda.io/d/_dAbCDeFGH",
                "type": "doc",
                "icon": {
                    "name": "string",
                    "type": "string",
                    "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
                },
                "title": "Cool Geometry Formulas",
                "createdAt": "2022-04-11T00:18:57.946Z",
                "publishedAt": "2022-04-12T00:18:57.946Z"
            },
            "metrics": [
                {
                    "date": "2020-09-02",
                    "views": 980,
                    "copies": 24,
                    "likes": 342,
                    "sessionsMobile": 530,
                    "sessionsDesktop": 212,
                    "sessionsOther": 10,
                    "totalSessions": 1000,
                    "aiCreditsChat": 10,
                    "aiCreditsBlock": 10,
                    "aiCreditsColumn": 10,
                    "aiCreditsAssistant": 10,
                    "aiCreditsReviewer": 10,
                    "aiCredits": 50
                }
            ]
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/analytics/docs?pageToken=xyz"
}

请求参数

Query 参数

docIds

array[string]

可选

List of docIds to fetch.

workspaceId

string

可选

ID of the workspace.

示例值:

ws-1Ab234

query

string

可选

Search term used to filter down results.

示例值:

Supercalifragilisticexpialidocious

isPublished

boolean

可选

Limit results to only published items.

sinceDate

string <date>

可选

Limit results to activity on or after this date.

示例值:

2020-08-01

untilDate

string <date>

可选

Limit results to activity on or before this date.

示例值:

2020-08-05

scale

enum<string>

可选

Quantization period over which to view analytics. Defaults to daily.

枚举值:

dailycumulative

pageToken

string

可选

An opaque token used to fetch the next page of results.

示例值:

eyJsaW1pd

orderBy

enum<string>

可选

Use this parameter to order the doc analytics returned.

枚举值:

datedocIdtitlecreatedAtpublishedAtlikescopiesviewssessionsDesktopsessionsMobilesessionsOthertotalSessionsaiCreditsChataiCreditsBlockaiCreditsColumnaiCreditsAssistantaiCreditsRevieweraiCredits

direction

enum<string>

可选

Direction to sort results in.

枚举值:

ascendingdescending

limit

integer

可选

Maximum number of results to return in this query.

>= 1<= 5000

默认值:

1000

示例值:

返回响应

🟢200List of Coda doc analytics.

application/json

Body

List of analytics for Coda docs over a date range.

nextPageToken

string

可选

If specified, an opaque token used to fetch the next page of results.

示例值:

eyJsaW1pd

items

array[object (DocAnalyticsItem) {2}]

必需

doc

object (DocAnalyticsDetails)

必需

Metadata about a doc relevant to analytics.

metrics

array[object (DocAnalyticsMetrics) {14}]

必需

nextPageLink

string <url>

可选

If specified, a link that can be used to fetch the next page of results.

示例值:

https://coda.io/apis/v1/analytics/docs?pageToken=xyz

🟠401401

🟠429429

修改于 2024-03-20 08:13:15

Trigger automation

List page analytics