Coda

Retrieve the logs of a Pack.

开发环境

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

GET

/packs/{packId}/docs/{docId}/logs

Packs

Retrieve the logs of a Pack for debugging purpose.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/packs/123/docs/AbCDeFGH/logs'

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "context": {
                "requestType": "unknown",
                "docId": "string",
                "packId": "string",
                "packVersion": "string",
                "formulaName": "string",
                "userId": "string",
                "connectionId": "string",
                "requestId": "string",
                "createdAt": "2018-04-11T00:18:57.946Z",
                "logId": "string",
                "docObjectId": "string",
                "docRowId": "string",
                "docColumnId": "string",
                "isSyncTable": true,
                "isContinuedSyncTable": true,
                "autocompleteParameterName": "string",
                "invocationSource": "string",
                "detailsKey": "string"
            },
            "level": "error",
            "message": "The formula is called!",
            "type": "custom"
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/packs/1/logs?pageToken=xyz"
}

请求参数

Path 参数

packId

integer

必需

ID of a Pack

>= 1

示例值:

123

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Query 参数

limit

integer

可选

Maximum number of results to return in this query.

>= 1<= 100

默认值:

示例值:

pageToken

string

可选

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

示例值:

eyJsaW1pd

logTypes

array[string]

可选

Only return logs of the given types.

枚举值:

customfetcherinvocationinternalauth

示例值:

fetcher,custom

beforeTimestamp

string <date-time>

可选

Only return logs before the given time (non-inclusive).

示例值:

2018-04-11T00:18:57.946Z

afterTimestamp

string <date-time>

可选

Only return logs after the given time (non-inclusive).

示例值:

2018-04-11T00:18:57.946Z

order

enum<string>

可选

Specifies if the logs will be returned in time desc or asc. Default is desc.

枚举值:

ascdesc

string

可选

A search query that follows Lucene syntax.

示例值:

context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest"

requestIds

array[string]

可选

Only return logs matching provided request IDs.

示例值:

416faabf,4127faag

返回响应

🟢200Pack logs.

application/json

Body

List of Pack logs.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[null (PackLog) {5}]

必需

object

PackCustomLog

可选

Pack log generated by developer's custom logging with context.logger.

object

PackInvocationLog

可选

System logs of the invocations of the Pack.

object

PackFetcherLog

可选

System logs of Pack calls to context.fetcher.

object

PackInternalLog

可选

Coda internal logs from the packs infrastructure. Only visible to Codans.

object

PackAuthLog

可选

System logs of Pack authentication requests.

nextPageLink

string <url>

可选

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

示例值:

https://coda.io/apis/v1/packs/1/logs?pageToken=xyz

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

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

Retrieve the system connection metadata of the Pack.

Retrieve the grouped logs of a Pack.