List App Chat Logs
Query paginated FastGPT application chat logs filtered by time range, channel source, feedback status, errors, and search keywords.
Endpoint Overview
- Method :
POST - Path :
/api/core/app/logs/list - Module : Applications / App Logs
- Authentication :
Authorization: Bearer <apiKey>—Supports App API Key (appIdoptional) and Personal API Key (appIdrequired) (see API Getting Started ) - Interactive Try-It-Out : Open in Scalar API Explorer (self-hosted instances: replace the origin with
<instance>/apidoc/systemopenapi#tag/%E5%BA%94%E7%94%A8%E6%97%A5%E5%BF%97/POST/core/app/logs/list)
Description & Notes
Retrieve paginated application chat logs with filters for time range, source, feedback status, errors, and users.
Request Parameters
Request Body ( application/json )
Mutually Exclusive Branches ( anyOf )
- Explicit App ID
Personal API keys and login sessions must pass appId ; an App API Key always uses the bound application.
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
appId | string | Yes | - | Application ID. minLength: 1 |
- App API Key (no appId required)
When authorizing with an app-bound App API Key, omit appId and sourceType ; the server resolves the bound app with sourceType fixed to app . Personal keys and login sessions cannot omit appId , and an explicit appId does not override an App API Key binding.
No extra branch-specific fields are required.
Shared Parameters Across Branches
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
feedbackType | string (enum) | No | - | Feedback filter: all (all logs), has_feedback (logs with feedback), good (likes), bad (dislikes). Allowed values: all , has_feedback , good , bad |
unreadOnly | boolean | No | - | Whether to return only unread feedback (ignored when feedbackType is all ) |
errorFilter | string (enum) | No | - | Error filter: all (all logs), has_error (error logs only). Allowed values: all , has_error |
dateStart | string | Yes | - | Start time |
dateEnd | string | Yes | - | End time |
sources | string (enum)[]` | No | - | Chat source filter |
tmbIds | string[] | No | - | List of team member IDs |
outLinkUids | string[] | No | - | List of external user IDs |
chatSearch | string | No | - | Search keyword for chat content |
Mutually Exclusive Branches ( anyOf )
- Offset Pagination
Specify the 0-based starting offset; when both offset and pageNum are provided, offset takes precedence.
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
offset | integer | Yes | - | Mutually Exclusive Group: Pagination Parameters . 0-based offset. min: 0; max: 9007199254740991 |
pageSize | integer | No | 20 | Mutually Exclusive Group: Pagination Parameters . Items per page. Defaults to 20, capped at 500 (larger values are clamped to 500). max: 500 |
- Page-Number Pagination
Paginate by page number (starts at page 1); pageSize controls items per page.
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
pageNum | integer | No | 1 | Mutually Exclusive Group: Pagination Parameters . 1-based page number; ignored when offset is provided. max: 9007199254740991 |
pageSize | integer | No | 20 | Mutually Exclusive Group: Pagination Parameters . Items per page. Defaults to 20, capped at 500 (larger values are clamped to 500). max: 500 |
Request Examples
Replace YOUR_API_KEY and placeholder IDs before running. Self-hosted users should replace the base URL with <instance>/api .
cURL Example
curl --fail-with-body -X POST "https://cloud.fastgpt.io/api/core/app/logs/list" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
--data-raw '{
"appId": "68ad85a7463006c963799a05",
"offset": 0,
"dateStart": "2024-01-01T00:00:00.000Z",
"dateEnd": "2024-12-31T23:59:59.999Z"
}'Minimal Valid JSON Body
{
"appId": "68ad85a7463006c963799a05",
"offset": 0,
"dateStart": "2024-01-01T00:00:00.000Z",
"dateEnd": "2024-12-31T23:59:59.999Z"
}Response Schema & Examples
Successful /api/* calls return the standard FastGPT envelope { "code": 200, "statusText": "", "message": "", "data": ... } , where data matches the 200 schema below (when a payload schema is declared; otherwise refer to the status description for runtime data semantics).
HTTP 200
Successfully retrieved application chat logs
Content-Type : application/json
| Field | Type | Required | Default | Constraints & Description |
|---|---|---|---|---|
total | number | Yes | - | Total record count |
list | object[] | Yes | - | List of chat log records |
list[].publishSource | object | No | - | - |
list[].publishSource.type | string (enum) | No | "unknown" | Channel type of the latest run; falls back to unknown if unrecognized. Allowed values: test , online , share , api , cronJob , feishu , official_account , wecom , wechat , mcp , dingtalk , unknown |
list[].publishSource.id | string | No | - | Database ID of the channel record; omitted for internal entry points or legacy data without recoverable references. pattern: ^[0-9a-fA-F]{24}$ |
list[].publishSource.name | string | No | - | Current channel name, compatible with legacy source names |
list[]._id | string | Yes | - | Chat log ID |
list[].chatId | string | Yes | - | Chat ID. maxLength: 1024 |
list[].title | string | null | No | - | Chat title |
list[].customTitle | string | null | No | - | Custom chat title |
list[].source | string (enum) | Yes | "unknown" | Deprecated . Legacy channel type retained for compatibility; use publishSource.type instead. Allowed values: test , online , share , api , cronJob , feishu , official_account , wecom , wechat , mcp , dingtalk , unknown |
list[].sourceName | string | null | No | - | Deprecated . Legacy channel name retained for compatibility; use publishSource.name instead |
list[].updateTime | string | Yes | - | Update time |
list[].createTime | string | null | No | - | Creation time |
list[].messageCount | integer | null | No | - | Message count |
list[].userGoodFeedbackCount | integer | null | No | - | Positive feedback count |
list[].userBadFeedbackCount | integer | null | No | - | Negative feedback count |
list[].customFeedbacksCount | integer | null | No | - | Custom feedback count |
list[].markCount | integer | null | No | - | Marked count |
list[].averageResponseTime | number | null | No | - | Average response time (ms) |
list[].errorCount | integer | null | No | - | Error count |
list[].totalPoints | number | null | No | - | Total credit points consumed |
list[].outLinkUid | string | null | No | - | End user ID from a share link visitor or API customUid ; takes precedence over tmbId when non-empty |
list[].tmbId | string | null | No | - | Effective authenticated team member ID (or proxied member ID when using authProxy ) |
list[].sourceMember | object | null | No | - | Source member details (compatibility field; may represent a guest for share-link traffic) |
list[].authMember | object | null | No | - | Authenticated member metadata resolved by tmbId , for display only |
list[].versionName | string | null | No | - | Version name |
list[].originIp | string | null | No | - | Origin IP address |
list[].region | string | null | No | - | Region |
Last updated