API
ユーザーシート (サブアカウント)
ユーザーサブアカウントの表示
説明
このメソッドは、ユーザーの全てのサブアカウントのリストを取得できます。
リクエストフォーマット
GET /usersパラメータ:
| 名称 | 説明 |
| limit | ページあたりの制限を指定 標準は100 |
| offset | 選択バイアス |
結果
成功すると、サーバーはサブアカウントのリスト (list) とその合計数を含むオブジェクトを個別のエントリ (all_count) として返します。
リスト配列の各要素はサブアカウントについての情報を示します。
| 名称 | 説明 |
| account_id | 固有のアカウント ID |
| account_emai | Email サブアカウント |
| account_first_name | 名 |
| account_last_name | 性 |
| account_type | アカウントタイプ (ユーザー、クライアント) |
| account_lang | アカウント言語 |
| account_sites_count | アカウントあたりで利用可能なウェブサイト数 |
| is_blocked_by_limits | ブール値 制限が切れているか？ |
レスポンス例
{
"list": [
{
"account_id": 36865,
"account_email": "[email protected]",
"account_first_name": "John",
"account_last_name": "Doe",
"account_type": "user",
"account_lang": "ru",
"account_sites_count": 2,
"is_blocked_by_limits": false
},
{
"account_id": 36828,
"account_email": "[email protected]",
"account_first_name": "Jane",
"account_last_name": "Doe",
"account_type": "client",
"account_lang": "ru",
"account_sites_count": 1,
"is_blocked_by_limits": false
}
],
"all_count": "2"
}サブアカウントの拡張情報取得
説明
このメソッドは、制限や権限を含むサブアカウントの拡張情報を取得できます。
リクエストフォーマット
GET /users/{id}結果
成功すると、サーバーは三つの要素で構成されるオブジェクトを返します:
| 名称 | 説明 |
| settings | サブアカウント情報 |
| access | サブアカウントのアクセス |
| limit | サブアカウントの制限 |
アクセス要素は次の項目で構成されます:
| 名称 | 説明 |
| audit_website | サイトSEO検査 |
| competitors_visibility_ranking | ヴィジビリティ順位 |
| audit_settings | 検査設定 |
| backlink_monitor | 被リンク監視 |
| analytics_conversions | アナリティクス: コンバージョン |
| analytics_google_search_console | Google search console |
| competitors_added | 主要な競合 |
| analytics_overview | 分析: 概要 |
| analytics_pages | 分析: ページ |
| marketing_plan | マーケティングプラン |
| seo_potential | SEO ポテンシャル |
| analytics_snippets | 分析: スニペット |
| social_media | ソーシャルメディア |
| tools_backlinks_checker | ツール: 被リンクチェッカー |
| tools_index_status_checker | ツール: インデックスステータスチェッカー |
| tools_parameter_checker | ツール: パラメータチェッカー |
| tools_keyword_grouper | ツール: キーワードグループ化 |
| tools_engine_autocomplete | ツール: 検索エンジンオートコンプリート |
| tools_search_volume_checker | ツール: 検索ボリュームチェッカー |
| tools_competitive_research | ツール: 競合調査 |
| tools_keyword_research | ツール: キーワード調査 |
| tools_one_page_seo_checker | ツール: ページSEOチェッカー |
| competitors_serp | 競合SERP |
| analytics_traffic_sources | 分析: トラフィックソース |
| analytics_audience | 分析: オーディエンス |
| audit_page_changes_monitor | 検査: ページ変更検知 |
| hide_search_volume | クライアントアカウントタイプで検索ボリュームを隠す |
| show_groups | グループを表示 |
| report_manual | 手動レポート |
| report_sheduled | 定期レポート |
| report_template | レポートテンプレート |
制限の関する要素は次の項目で構成されます:
| 名称 | 説明 |
| site | 整数 ウェブサイト追加上限 |
| keyword | 整数 キーワード追加上限 |
| backlink | 整数 被リンクチェック追加上限 |
| audit_account | 整数 サイト検査回数 (アカウントあたり) |
| audit_site | 整数 サイトチェック上限 (サイト、一ヵ月あたり) |
| balance.amount | 整数 支払い制限 |
| balance.period | 文字列 支払い制限 (日、週、月) |
レスポンス例:
{
"setting": {
"account_id": 36828,
"account_email": "[email protected]",
"account_first_name": "Test",
"account_last_name": "Test",
"account_type": "user",
"account_lang": "ru"
},
"access": [
"add_website",
"audit_settings",
"report_manual",
"report_sheduled",
"report_template"
],
"limit": {
"site": 10,
"keyword": 5,
"backlink": 10,
"audit_account": 4,
"audit_site": 3,
"balance": {
"amount": 5,
"period": "day"
}
}
}
サブアカウント作成
説明
このメソッドは、サブアカウントを作成してそれに紐づけられたEメールに通知メールを送信します。
| 名称 | 必須 | 説明 |
| key | はい | 必須値 “data” |
| value | はい | 作成されたアカウント設定 |
| setting.account_email | はい | サブアカウントのEメール |
| setting.account_first_name | はい | サブアカウント 名 |
| setting.account_last_name | いいえ | サブアカウント 性 |
| setting.account_password | はい | サブアカウントパスワード |
| setting.account_lang | いいえ | アカウント言語 2文字のコード |
| setting.account_type | いいえ | アカウントタイプ: クライアント、ユーザー |
| limit.balance.period | いいえ | 制限の有効期限 日、週、月 |
| limit.balance.amount | いいえ | 金額の制限値 整数 |
| access | いいえ | 新しいサブアカウントの権限が付与されたセクション |
リクエストフォーマット
POST /users
[
{
"key":"data",
"value": [
{"setting.account_email":"[email protected]"},
{"setting.account_first_name":"Test"},
{"setting.account_last_name":"Test"},
{"setting.account_password":"TestPassword"},
{"setting.account_type":"user"},
{"limit.balance.period":"day"},
{"limit.balance.amount":10},
"access": [
"add_website",
"audit_settings",
"report_manual",
"report_sheduled",
"report_template"
]
}
]
}
]結果
成功すると、サーバーは追加されたサブアカウントに関する固有のIDを返します。
Response example:
{
"id": 36872
}サブアカウントの削除
説明
このメソッドはユーザーのサブアカウントを削除します。
リクエストフォーマット
DELETE /users/{id}結果
成功すると、サーバーは空の配列を返します
レスポンス例:
[]サブアカウント編集
説明
このメソッドは、既存のサブアカウントの編集を行います。
| 名称 | 必須 | 説明 |
| key | はい | 必須値 “data” |
| value | はい | 作成されたアカウント設定 |
| setting.account_email | いいえ | サブアカウントのEメール |
| setting.account_first_name | いいえ | サブアカウント 名 |
| setting.account_last_name | いいえ | サブアカウント 性 |
| setting.account_password | いいえ | サブアカウントパスワード |
| setting.account_lang | いいえ | アカウント言語 2文字のコード |
| setting.account_type | いいえ | アカウントタイプ: クライアント、ユーザー |
| limit.balance.period | いいえ | 制限の有効期限 日、週、月 |
| limit.balance.amount | いいえ | 金額の制限値 整数 |
| access | いいえ | 新しいサブアカウントの権限が付与されたセクション |
リクエストフォーマット
PATCH /users/{id}
[
{
"key":"data",
"value": [
{"setting.account_email":"[email protected]"},
{"setting.account_first_name":"Test"},
{"setting.account_last_name":"Test"},
{"setting.account_password":"TestPassword"},
{"setting.account_type":"user"},
{"limit.balance.period":"day"},
{"limit.balance.amount":10},
{"access": [
"add_website"
]
}
]
}
]結果
成功すると、サーバーは空の配列を返します。
レスポンス例:
{
[]
}親アカウントでサブアカウントと共有されたウェブサイトのリストを取得
説明
このメソッドは、サブアカウントで利用可能なウェブサイトのリストを取得します。
リクエストフォーマット
GET /users/{id}/shared-sites| 名称 | 説明 |
| id | 固有のアカウントID |
結果
成功すると、サーバーはサブアカウントで共有されたウェブサイトの固有IDの配列を返します。
レスポンス例:
[
39,
44
]サブアカウントに割り当てられているウェブサイトのリストを取得
説明
このメソッドは、サブアカウントに割り当てられているウェブサイトのリストを取得します。
リクエストフォーマット
GET /users/{id}/own-sites| 名称 | 説明 |
| id | 固有のアカウントID |
結果
成功すると、サーバーはサブアカウントに割り当てられているウェブサイトの固有IDの配列を返します。
レスポンス例:
[
39,
44
]サブアカウントにウェブサイトへのアクセスを付与
説明
このメソッドはサブアカウントにウェブサイトへのアクセスを付与します。
リクエストフォーマット
POST /users/{id}/shared-sites
[39,42]
| 名称 | 説明 |
| id | 固有のアカウントID |
| 39,42 | 固有のウェブサイトID |
結果
成功すれば、サーバーは空の配列を返します。
レスポンス例
{
[]
}