开发者文档
项目运营报表
GET
/api/orgs/:orgId/project-report权限与前置条件
当前有效工作区成员;工作区及账号必须有效。
此接口仅支持浏览器登录,不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。
请求参数
orgId · 路径参数 · 必填字符串
Query 查询参数
| 字段 | 类型 | 必填 | 约束 |
|---|---|---|---|
projectId | string | 否 | {"minLength":1,"maxLength":32} |
status | string | 否 | {"enum":["pending","partial","paid","overpaid","reversed"]} |
from | string | 否 | {"format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"} |
to | string | 否 | {"format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"} |
查看完整请求 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"status": {
"type": "string",
"enum": [
"pending",
"partial",
"paid",
"overpaid",
"reversed"
]
},
"from": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"to": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
}
}
}调用示例
先通过浏览器统一登录,使用受控环境中的已有会话。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。
cURL · 示例占位值需替换
curl --request GET \
'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/project-report' \
--cookie "$SUREN360_COOKIE"响应结构
成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。
| 字段 | 类型 | 必填 | 约束 |
|---|---|---|---|
effects | object | 是 | {"required":["diggCount","collectCount","commentCount","diggCoverage","collectCoverage","commentCoverage","coveredCount","latestFetchedAt","rankings"],"additionalProperties":false} |
summary | object | 是 | {"required":["recoveredCount","creatorCount","confirmedFeeFen","averageFeeFen","pendingFen","overpaidFen","settledCount","unsettledCount"],"additionalProperties":false} |
items | array | 是 | {} |
查看完整响应 JSON Schema
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"effects": {
"type": "object",
"properties": {
"diggCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"commentCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"diggCoverage": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"collectCoverage": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"commentCoverage": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coveredCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"latestFetchedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"rankings": {
"type": "object",
"properties": {
"diggCount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"title": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"platform": {
"type": "string"
},
"contentUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"confirmedFeeFen": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"playCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"diggCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"commentCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"title",
"creatorName",
"platform",
"contentUrl",
"confirmedFeeFen",
"fetchedAt",
"playCount",
"diggCount",
"collectCount",
"commentCount"
],
"additionalProperties": false
}
},
"collectCount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"title": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"platform": {
"type": "string"
},
"contentUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"confirmedFeeFen": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"playCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"diggCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"commentCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"title",
"creatorName",
"platform",
"contentUrl",
"confirmedFeeFen",
"fetchedAt",
"playCount",
"diggCount",
"collectCount",
"commentCount"
],
"additionalProperties": false
}
},
"commentCount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"title": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"platform": {
"type": "string"
},
"contentUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"confirmedFeeFen": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"playCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"diggCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collectCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"commentCount": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"title",
"creatorName",
"platform",
"contentUrl",
"confirmedFeeFen",
"fetchedAt",
"playCount",
"diggCount",
"collectCount",
"commentCount"
],
"additionalProperties": false
}
}
},
"required": [
"diggCount",
"collectCount",
"commentCount"
],
"additionalProperties": false
}
},
"required": [
"diggCount",
"collectCount",
"commentCount",
"diggCoverage",
"collectCoverage",
"commentCoverage",
"coveredCount",
"latestFetchedAt",
"rankings"
],
"additionalProperties": false
},
"summary": {
"type": "object",
"properties": {
"recoveredCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"creatorCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"confirmedFeeFen": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"averageFeeFen": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"pendingFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"overpaidFen": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"settledCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unsettledCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"recoveredCount",
"creatorCount",
"confirmedFeeFen",
"averageFeeFen",
"pendingFen",
"overpaidFen",
"settledCount",
"unsettledCount"
],
"additionalProperties": false
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"payableFen": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"recoveredCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"date",
"payableFen",
"recoveredCount"
],
"additionalProperties": false
}
}
},
"required": [
"effects",
"summary",
"items"
],
"additionalProperties": false
}