Coda

List Pack formula analytics

开发环境

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

GET

/analytics/packs/{packId}/formulas

Analytics

Returns analytics data for Pack formulas.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/analytics/packs/123/formulas'

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "formula": {
                "type": "action",
                "name": "SquareRoot"
            },
            "metrics": [
                {
                    "date": "2020-09-02",
                    "formulaInvocations": 123,
                    "errors": 5,
                    "medianLatencyMs": 500,
                    "medianResponseSizeBytes": 300,
                    "docsActivelyUsing": 50,
                    "docsActivelyUsing7Day": 100,
                    "docsActivelyUsing30Day": 200,
                    "docsActivelyUsing90Day": 300,
                    "docsActivelyUsingAllTime": 500,
                    "workspacesActivelyUsing": 10,
                    "workspacesActivelyUsing7Day": 15,
                    "workspacesActivelyUsing30Day": 20,
                    "workspacesActivelyUsing90Day": 30,
                    "workspacesActivelyUsingAllTime": 50,
                    "workspacesActivelyTrialing": 0,
                    "workspacesActivelyTrialing7Day": 0,
                    "workspacesActivelyTrialing30Day": 0,
                    "workspacesActivelyTrialing90Day": 0,
                    "workspacesActivelyTrialingAllTime": 0,
                    "workspacesNewlySubscribed": 0,
                    "workspacesWithActiveSubscriptions": 0,
                    "workspacesWithSuccessfulTrials": 0,
                    "revenueUsd": "string"
                }
            ]
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/analytics/packs/:packId/formulas?pageToken=xyz"
}

请求参数

Path 参数

packId

integer

必需

ID of a Pack

>= 1

示例值:

123

Query 参数

packFormulaNames

array[string]

可选

A list of Pack formula names (case-sensitive) for which to retrieve analytics.

示例值:

SquareRoot,CubeRoot

packFormulaTypes

array[string]

可选

A list of Pack formula types corresponding to the packFormulaNames. If specified, this must have the same length as packFormulaNames.

枚举值:

actionformulasyncmetadata

示例值:

action,formula

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 Pack formula analytics returned.

枚举值:

dateformulaNameformulaTypeformulaInvocationsmedianLatencyMsmedianResponseSizeByteserrorsdocsActivelyUsingdocsActivelyUsing7DaydocsActivelyUsing30DaydocsActivelyUsing90DaydocsActivelyUsingAllTimeworkspacesActivelyUsingworkspacesActivelyUsing7DayworkspacesActivelyUsing30DayworkspacesActivelyUsing90DayworkspacesActivelyUsingAllTime

direction

enum<string>

可选

Direction to sort results in.

枚举值:

ascendingdescending

limit

integer

可选

Maximum number of results to return in this query.

>= 1<= 5000

默认值:

1000

示例值:

返回响应

🟢200Response of Coda Pack formula analytics.

application/json

Body

A collection of analytics for Coda Packs formulas over a date range.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[object (PackFormulaAnalyticsItem) {2}]

必需

formula

object (PackFormulaIdentifier)

必需

metrics

array[object (PackFormulaAnalyticsMetrics) {24}]

必需

nextPageLink

string <url>

可选

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

示例值:

https://coda.io/apis/v1/analytics/packs/:packId/formulas?pageToken=xyz

🟠401401

🟠429429

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

Get analytics last updated day

List workspace users