보고서

노트
Expert level
API Key는 Authorization 헤더에 Bearer 토큰으로 전송되어야 합니다. API key 확인하기.
리스트

API endpoint:

GET 
https://seosecret.org/api/v1/reports

Request example: 

curl --location --request GET 'https://seosecret.org/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
옵션 string
검색어
search_by
옵션 string
검색 조건. 가능한 값: url 의 검사 웹사이트 주소. 기본값: url.
project
옵션 string
프로젝트명
result
옵션 string
The report result. 가능한 값: good 의 좋음, decent 의 양호, bad 의 안좋음.
sort_by
옵션 string
정렬 기준. 가능한 값: id 의 작성일 기준, generated_at 의 생성일 기준, url 의 검사 웹사이트 주소, result 의 검사(변환) 결과. 기본값: id.
sort
옵션 string
정렬. 가능한 값: desc 의 안좋은 보고서부터, asc 의 좋은 보고서부터. 기본값: desc.
per_page
옵션 int
페이지당 표기할 보고서 수. 가능한 값: 10, 25, 50, 100. 기본값: 25.
보여주기

API endpoint:

GET 
https://seosecret.org/api/v1/reports/{id}

Request example: 

curl --location --request GET 'https://seosecret.org/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
저장하기

API endpoint:

POST 
https://seosecret.org/api/v1/reports

Request example: 

curl --location --request POST 'https://seosecret.org/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Description
url
필수 string
The webpage's URL.
privacy
옵션 integer
Report page privacy. 가능한 값: 0 의 공개, 1 의 비공개, 2 의 패스워드. 기본값: 1.
password
옵션 string
The password for the report page. Only works with privacy set to 2.
업데이트

API endpoint:

PUT PATCH 
https://seosecret.org/api/v1/reports/{id}

Request example: 

curl --location --request PUT 'https://seosecret.org/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
privacy
옵션 integer
Report page privacy. 가능한 값: 0 의 공개, 1 의 비공개, 2 의 패스워드.
password
옵션 string
The password for the report page. Only works with privacy set to 2.
results
옵션 integer
Update the report results. 가능한 값: 0 의 아니요, 1 의 네. 기본값: 0.
삭제하기

API endpoint:

DELETE 
https://seosecret.org/api/v1/reports/{id}

Request example: 

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