Webサイト

メモ
エキスパートレベル
API キーは、リクエストの Authorization ヘッダーでベアラー トークンとして送信する必要があります。 API キーを取得する.
リスト

API エンドポイント:

GET 
https://analytics.okensaku.com/api/v1/websites

リクエスト例: 

curl --location --request GET 'https://analytics.okensaku.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
パラメータ
タイプ
説明
search
オプション string
検索クエリ
search_by
オプション string
検索条件. 可能な値は次のとおりです: domain の ドメイン. デフォルト: domain.
favorite
オプション boolean
Filter by favorite.
sort_by
オプション string
並べ替え. 可能な値は次のとおりです: id の 作成日, domain の ドメイン. デフォルト: id.
sort
オプション string
並べ替え. 可能な値は次のとおりです: desc の 降順, asc の 昇順. デフォルト: desc.
per_page
オプション integer
ページあたりの結果. 可能な値は次のとおりです: 10, 25, 50, 100. デフォルト: 50.
ショー

API エンドポイント:

GET 
https://analytics.okensaku.com/api/v1/websites/{id}

リクエスト例: 

curl --location --request GET 'https://analytics.okensaku.com/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ストア

API エンドポイント:

POST 
https://analytics.okensaku.com/api/v1/websites

リクエスト例: 

curl --location --request POST 'https://analytics.okensaku.com/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
パラメータ
タイプ
説明
domain
必須 string
ドメイン名
privacy
オプション integer
統計ページのプライバシー 可能な値は次のとおりです: 0 の 公的, 1 の プライベート, 2 の パスワード. デフォルト: 0.
password
オプション string
統計ページのパスワード。 privacy を 2 に設定した場合のみ機能します。
email
オプション integer
定期的なメール レポート 可能な値は次のとおりです: 0 の 無効, 1 の 有効. デフォルト: 0.
exclude_bots
オプション integer
一般的なボットを追跡から除外します。 可能な値は次のとおりです: 0 の 無効, 1 の 有効. デフォルト: 1.
exclude_params
オプション string
Exclude URL query parameters from being tracked. 1行に1つ.
exclude_ips
オプション string
追跡対象から IP を除外します。 1行に1つ.
アップデート

API エンドポイント:

PUT PATCH 
https://analytics.okensaku.com/api/v1/websites/{id}

リクエスト例: 

curl --location --request PUT 'https://analytics.okensaku.com/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
パラメータ
タイプ
説明
privacy
オプション integer
統計ページのプライバシー 可能な値は次のとおりです: 0 の 公的, 1 の プライベート, 2 の パスワード.
password
オプション string
統計ページのパスワード。 privacy を 2 に設定した場合のみ機能します。
email
オプション integer
定期的なメール レポート 可能な値は次のとおりです: 0 の 無効, 1 の 有効.
exclude_bots
オプション integer
一般的なボットを追跡から除外します。 可能な値は次のとおりです: 0 の 無効, 1 の 有効.
exclude_params
オプション string
Exclude URL query parameters from being tracked. 1行に1つ.
exclude_ips
オプション string
追跡対象から IP を除外します。 1行に1つ.
favorite
オプション boolean
Whether the website is favorite or not.
削除

API エンドポイント:

DELETE 
https://analytics.okensaku.com/api/v1/websites/{id}

リクエスト例: 

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