Báo cáo

Ghi chú
Expert level
Khóa API nên được gửi dưới dạng mã thông báo Bearer trong tiêu đề Authorization của yêu cầu. Lấy khóa API của bạn.
Danh sách

Điểm cuối API:

GET 
https://ngheseo.vn/api/v1/reports

Ví dụ yêu cầu: 

curl --location --request GET 'https://ngheseo.vn/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tham số
Loại
Mô tả
search
tùy chọn string
Truy vấn tìm kiếm.
search_by
tùy chọn string
Tìm kiếm theo. Các giá trị có thể là: url cho URL. Mặc định là: url.
project
tùy chọn string
Tên dự án.
result
tùy chọn string
The report result. Các giá trị có thể là: good cho Tốt, decent cho Khá, bad cho Kém.
sort_by
tùy chọn string
Sắp xếp theo. Các giá trị có thể là: id cho Ngày tạo, generated_at cho Ngày tạo, url cho URL, result cho Kết quả. Mặc định là: id.
sort
tùy chọn string
Sắp xếp. Các giá trị có thể là: desc cho Giảm dần, asc cho Tăng dần. Mặc định là: desc.
per_page
tùy chọn integer
Kết quả mỗi trang. Các giá trị có thể là: 10, 25, 50, 100. Mặc định là: 10.
Hiển thị

Điểm cuối API:

GET 
https://ngheseo.vn/api/v1/reports/{id}

Ví dụ yêu cầu: 

curl --location --request GET 'https://ngheseo.vn/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Lưu trữ

Điểm cuối API:

POST 
https://ngheseo.vn/api/v1/reports

Ví dụ yêu cầu: 

curl --location --request POST 'https://ngheseo.vn/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Tham số
Loại
Mô tả
url
bắt buộc string
The webpage's URL.
privacy
tùy chọn integer
Report page privacy. Các giá trị có thể là: 0 cho Công khai, 1 cho Riêng tư, 2 cho Mật khẩu. Mặc định là: 0.
password
tùy chọn string
The password for the report page. Only works with privacy set to 2.
Cập nhật

Điểm cuối API:

PUT PATCH 
https://ngheseo.vn/api/v1/reports/{id}

Ví dụ yêu cầu: 

curl --location --request PUT 'https://ngheseo.vn/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Tham số
Loại
Mô tả
privacy
tùy chọn integer
Report page privacy. Các giá trị có thể là: 0 cho Công khai, 1 cho Riêng tư, 2 cho Mật khẩu.
password
tùy chọn string
The password for the report page. Only works with privacy set to 2.
results
tùy chọn integer
Update the report results. Các giá trị có thể là: 0 cho Không, 1 cho Có. Mặc định là: 0.
Xóa

Điểm cuối API:

DELETE 
https://ngheseo.vn/api/v1/reports/{id}

Ví dụ yêu cầu: 

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