列出属于某个项目的所有页面
GET
api/v1/projects/{projectId}/pages检索与项目关联的所有页面的列表。此端点允许您获取项目详细信息和属于特定项目的页面集合。每个页面对象包括页面 ID、URL、URL 哈希、项目 ID、爬网状态、索引状态、文件详细信息(如果适用)、创建和更新时间戳以及其他相关属性等信息。以下是列出属于项目API SDK
请求参数
Path 参数
projectId
string
必需
唯一的项目标识符。
Query 参数
page
string
返回的页码
示例值:
1
duration
string
可选
要列出的项目的持续时间。默认为 90 天。
示例值:
90
order
string
可选
项目列出的顺序。默认为描述。
示例值:
desc
示例代码
返回响应
成功(200)
请求有误(400)
没有权限(401)
记录不存在(404)
服务器错误(500)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
status
string
必需
data
object
必需
project
object
必需
pages
object
必需
示例
成功示例
{
"status": "success",
"data": {
"project": {
"id": 1,
"project_name": "My Project",
"sitemap_path": "https://www.example.com/sitemap.xml",
"is_chat_active": true,
"user_id": 1,
"team_id": 1,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00",
"deleted_at": "2021-01-01 00:00:00",
"type": "SITEMAP",
"is_shared": true,
"shareable_slug": "1234567890abcdef1234567890abcdef",
"shareable_link": "string",
"embed_code": "string",
"live_chat_code": "string"
},
"pages": {
"current_page": 1,
"data": [
{
"id": 1,
"page_url": "https://example.com",
"page_url_hash": "d41d8cd98f00b204e9800998ecf8427e",
"project_id": 1,
"s3_path": "project-1/page-1/file.pdf",
"crawl_status": "queued",
"index_status": "queued",
"is_file": true,
"is_file_kept": true,
"filename": "file.pdf",
"filesize": 100,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00",
"deleted_at": "2021-01-01 00:00:00"
}
],
"first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"path": "https://app.customgpt.ai/api/v1/users?page=1",
"per_page": 10,
"prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
"to": 1,
"total": 1
}
}
}
最后修改时间: 10 months ago