List page analytics

开发环境

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

GET

/analytics/docs/{docId}/pages

Analytics

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.

请求示例

Python

Shell

JavaScript

Java

curl --location --request GET 'http://dev-cn.your-api-server.com/analytics/docs/AbCDeFGH/pages'

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "page": {
                "icon": {
                    "name": "string",
                    "type": "string",
                    "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
                },
                "id": "section-IjkLmnO",
                "name": "Launch Status"
            },
            "metrics": [
                {
                    "date": "2022-06-03",
                    "views": 980,
                    "sessions": 24,
                    "users": 42,
                    "averageSecondsViewed": 42
                }
            ]
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/analytics/docs/DOC_ID/pages?pageToken=xyz"
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Query 参数

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

pageToken

string

可选

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

示例值:

eyJsaW1pd

limit

integer

可选

Maximum number of results to return in this query.

>= 1<= 5000

默认值:

1000

示例值:

返回响应

🟢200List of page analytics for the given Coda doc.

application/json

Body

List of analytics for pages within a Coda doc over a date range.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[object (PageAnalyticsItem) {2}]

必需

page

object (PageAnalyticsDetails)

必需

Metadata about a page relevant to analytics.

metrics

array[object (PageAnalyticsMetrics) {5}]

必需

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/DOC_ID/pages?pageToken=xyz

🟠401401

🟠429429

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

List doc analytics

Get doc analytics summary