报告

备注
Expert level
API密钥应作为承载令牌在请求的Authorization标头中发送. 获取API密钥.
列表

API 端点:

GET 
https://dongxiyun.com/api/v1/reports

请求示例: 

curl --location --request GET 'https://dongxiyun.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
参数
类型
说明
search
可选 string
搜索查询.
search_by
可选 string
搜索方式. 可能值: url for URL. 默认值: url.
project
可选 string
项目名称.
result
可选 string
The report result. 可能值: good for 优质的, decent for 合格, bad for 不合格.
sort_by
可选 string
排序. 可能值: id for 创建日期, generated_at for 生成日期, url for URL, result for 结果. 默认值: id.
sort
可选 string
排序. 可能值: desc for 下降, asc for 上升. 默认值: desc.
per_page
可选 integer
每页显示结果数量. 可能值: 10, 25, 50, 100. 默认值: 25.
显示

API 端点:

GET 
https://dongxiyun.com/api/v1/reports/{id}

请求示例: 

curl --location --request GET 'https://dongxiyun.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
保存

API 端点:

POST 
https://dongxiyun.com/api/v1/reports

请求示例: 

curl --location --request POST 'https://dongxiyun.com/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
参数
类型
说明
url
必需 string
The webpage's URL.
privacy
可选 integer
Report page privacy. 可能值: 0 for 公共, 1 for 私人, 2 for 密码. 默认值: 0.
password
可选 string
The password for the report page. Only works with privacy set to 2.
更新

API 端点:

PUT PATCH 
https://dongxiyun.com/api/v1/reports/{id}

请求示例: 

curl --location --request PUT 'https://dongxiyun.com/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
参数
类型
说明
privacy
可选 integer
Report page privacy. 可能值: 0 for 公共, 1 for 私人, 2 for 密码.
password
可选 string
The password for the report page. Only works with privacy set to 2.
results
可选 integer
Update the report results. 可能值: 0 for 否, 1 for 是. 默认值: 0.
删除

API 端点:

DELETE 
https://dongxiyun.com/api/v1/reports/{id}

请求示例: 

curl --location --request DELETE 'https://dongxiyun.com/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'