Tweet about this on TwitterShare on FacebookGoogle+

キーワードレポーティングAPI

キーワードレポーティングAPIは自社サイトのキーワードランキング情報を返すAPIです。3つのメソッドがあります:

  • キーワードパフォーマンス
  • キーワードランキングトレンド
  • キーワード追加

キーワードパフォーマンスメソッド

検索エンジンのキーワードランキングを集計するためのメソッドです。

リクエスト

  • URL: https://app.ginzametrics.com/api/v3/keywords/rankings
  • HTTP Method: GET

必須パラメータ

  • api_key — APIキー
  • site_global_key — サイトのグローバルキー(”アカウントマネジメントAPI”をご覧ください)
  • search_engine_global_key — 取得したい検索エンジン(例: “google_us”, ”yahoo_us”,”bing_us”).
  • date_from — 期間の開始日(例: “2013-05-01”)
  • date_to — 期間の終了日(例: “2013-05-18”)

任意パラメータ

  • granularity — 集計単位の日別‘daily’、週別‘weekly’、月別‘monthly’を指定します。デフォルトは日別です。
  • groups — キーワードグループを指定します。コンマ区切りで複数指定できます。(例: “Group_1,Group_2”)
  • conversion_events — 取得したいコンバージョンのイベントID(Account Sitesメソッドで取得できます)を指定します。(例: 42,84,124).
  • limit — 表示するキーワードの上限を指定します。デフォルトは100件です。
  • offset — キーワードの上限を指定した場合のオフセット値を指定します。デフォルトは0もしくはオフセット値なしです。
  • sort_col — ソートするカラムを指定します。デフォルトは’visits’です。
  • sort_dir — ソートの昇順降順を指定します。デフォルトは‘desc’です。
  • include_keyword_groups — キーワード毎にグループネームを表示するかどうかを指定します。(例: “true”)

リクエスト例

curl https://app.ginzametrics.com/api/v3/keywords/rankings \
-d api_key=API_KEY \
-d site_global_key=SITE_GLOBAL_KEY \
-d search_engine_global_key=google_us \
-d date_from=2013-03-01 \
-d date_to=2013-03-15 \
-d include_keyword_groups=true

レスポンス

レスポンスはJSON形式で返します。確認用のリクエストパラメータと、キーワードリストを以下の詳細情報とともに返します:

keyword キーワード
rank 期間最終日のキーワードランキング
rank_change 期間中のキーワードランキングの変化
url キーワードに対して検索エンジン結果で表示されるウェブページのURL
m_visits 期間中の訪問数
m_conversions 期間中のコンバージョン数
m_revenue 期間中のページ毎の売上金額
search_volume 検索結果画面からの訪問数
webmaster_metrics ウェブマスターツールの値:
average_position 期間中のランキング平均値
impressions インプレッション数
clicks クリック数
ctr CTR
groups キーワードがどのグループに属しているかを表示します(include_keyword_groups が “true”になっている場合のみ)

レスポンス例

{
    "meta": {
        "site_global_key": "GLOBAL_KEY",
        "account_name": "Ginzamarkets, Inc.",
        "search_engine_global_key": "google_us",
        "date_from": "2014-01-01",
        "date_to": "2014-01-14",
        "groups": null,
        "conversion_events": null,
        "sort_col": "rank",
        "sort_dir": "asc",
        "limit": 100,
        "offset": 0,
        "granularity": "daily"
    },
    "keywords": [
        {
            "keyword": "2012 outlook for seo",
            "rank": 1,
            "rank_change": null,
            "url": "http://ginzajp.wpengine.com/blog/2012-seo-and-inbound-marketing-outlook/",
            "m_visits": "-",
            "m_conversions": 0,
            "m_revenue": 0,
            "search_volume": "-",
            "webmaster_metrics": {
                "average_position": 1,
                "impressions": 44,
                "clicks": 0,
                "ctr": 0
            },
            "groups": [
                "SEO"
            ]
        },
        {
            "keyword": "37 signals saas pricing model",
            "rank": 1,
            "rank_change": null,
            "url": "http://ginzajp.wpengine.com/blog/dont-blindly-model-your-saas-pricing-on-37signals/",
            "m_visits": "-",
            "m_conversions": 0,
            "m_revenue": 0,
            "search_volume": "-",
            "webmaster_metrics": {
                "average_position": 1,
                "impressions": 43,
                "clicks": 0,
                "ctr": 0
            },
            "groups": [
                "Blog"
            ]
        },
        {
            "keyword": "api ginzametrics",
            "rank": 1,
            "rank_change": null,
            "url": "http://ginzajp.wpengine.com/api/",
            "m_visits": "-",
            "m_conversions": 0,
            "m_revenue": 0,
            "search_volume": "-",
            "webmaster_metrics": {
                "average_position": 1,
                "impressions": 303,
                "clicks": 0,
                "ctr": 0
            },
            "groups": [
                "Ginza Branded",
                "API"
            ]
        }
    ],
    "search_engine_global_key": "google_us"
}

キーワードランキングトレンドメソッド

キーワードのランキングがどう変化したかをみるためのメソッドです。

リクエスト

  • URL: https://app.ginzametrics.com/api/v3/keywords/rankings_trend
  • HTTP Method: GET

必須パラメータ

  • api_key — APIキー
  • site_global_key — サイトのグローバルキー(”アカウントマネジメントAPI”をご覧ください)
  • search_engine_global_key — 取得したい検索エンジン(例: “google_us”, ”yahoo_us”,”bing_us”).
  • date_from — 期間の開始日(例: “2013-05-01”)
  • date_to — 期間の終了日(例: “2013-05-18”)

任意パラメータ

  • granularity — 集計単位の日別‘daily’、週別‘weekly’、月別‘monthly’を指定します。デフォルトは日別です。
  • groups — キーワードグループを指定します。コンマ区切りで複数指定できます。(例: “Branded,SEO”)
  • conversion_events — 取得したいコンバージョンのイベントID( “アカウントマネジメントAPI” 内Account Sitesメソッドで取得できます)を指定します。(例: 42,84,124)
  • limit — 表示するキーワードの上限を指定します。デフォルトは100件です。
  • offset — キーワードの上限を指定した場合のオフセット値を指定します。デフォルトは0もしくはオフセット値なしです。
  • sort_col — ソートするカラムを指定します。デフォルトは’visits’です。
  • sort_dir — ソートの昇順降順を指定します。デフォルトは‘desc’です。
  • aggregation — キーワード軸“keywords”かキーワードグループ軸“groups”かを指定します。デフォルトはキーワード軸です。

リクエスト例

curl https://app.ginzametrics.com/api/v3/keywords/rankings_trend \
-d api_key=API_KEY \
-d site_global_key=SITE_GLOBAL_KEY \
-d search_engine_global_key=google_us \
-d date_from=2013-03-01 \
-d date_to=2013-03-15

レスポンス

レスポンスはJSON形式で返します。リクエストに関するメタ情報と、キーワードランキングを以下の詳細情報とともに返します:

keyword キーワード
trend 期間中の日別キーワードランキング

レスポンス例

{
    "meta": {
        "site_global_key": "GLOBAL_KEY",
        "search_engine_global_key": "google_us",
        "date_from": "2014-01-01",
        "date_to": "2014-01-04",
        "granularity": "daily",
        "aggregation": "keywords",
        "offset": 0,
        "limit": 100,
        "groups": null,
        "conversion_events": null,
        "sort_col": "rank",
        "sort_dir": "asc",
        "dates": [
            "2014-01-01",
            "2014-01-02",
            "2014-01-03",
            "2014-01-04"
        ]
    },
    "keywords": [
        {
            "keyword": "2012 outlook for seo",
            "trend": [
                1,
                1,
                1,
                1
            ]
        },
        {
            "keyword": "market size of seo",
            "trend": [
                1,
                1,
                1,
                1
            ]
        },
        {
            "keyword": "odin sso",
            "trend": [
                1,
                1,
                1,
                1
            ]
        },
        {
            "keyword": "bundler vs rvm",
            "trend": [
                2,
                2,
                3,
                2
            ]
        },
        {
            "keyword": "centralization vs decentralization chart",
            "trend": [
                2,
                2,
                2,
                2
            ]
        },
        {
            "keyword": "deploying rails ec2",
            "trend": [
                2,
                2,
                2,
                2
            ]
        },
        {
            "keyword": "deploying rails on aws",
            "trend": [
                2,
                2,
                2,
                2
            ]
        },
        {
            "keyword": "best saas pricing models",
            "trend": [
                2,
                3,
                3,
                3
            ]
        },
        {
            "keyword": "seo industry size",
            "trend": [
                3,
                4,
                3,
                3
            ]
        },
        {
            "keyword": "seo visibility score definition",
            "trend": [
                3,
                3,
                3,
                3
            ]
        },
        {
            "keyword": "support email tips",
            "trend": [
                3,
                2,
                3,
                3
            ]
        }
    ]
}

キーワード追加メソッド

その名の通り、新しくキーワードを追加するメソッドです。

リクエスト

  • URL: https://app.ginzametrics.com/api/v3/keywords/add_keywords
  • HTTP Method: GET

必須パラメータ

  • api_key — APIキー
  • site_global_key — サイトのグローバルキー(”アカウントマネジメントAPI”をご覧ください)
  • keywords — 追加するキーワードを指定します。コンマ区切りで複数指定できます。(例: “enterprize seo,premium seo”)

任意パラメータ

ありません。

リクエスト例

curl https://app.ginzametrics.com/api/v3/keywords/add_keywords \
-d api_key=API_KEY \
-d site_global_key=SITE_GLOBAL_KEY \
-d keywords=enterprize seo,premium seo

レスポンス

レスポンスはJSON形式で返します。リクエストに関するメタ情報と、追加したキーワードの情報とともに返します。

レスポンス例

{
    "meta": {
        "site_global_key": "GLOBAL_KEY",
        "account_name": "Ginzamarkets, Inc."
    },
    "keywords": [
        {
            "keyword_id": 16008110,
            "name": "enterprize seo",
            "groups": []
        },
        {
            "keyword_id": 16008111,
            "name": "premium seo",
            "groups": []
        }
    ]
}
Tweet about this on TwitterShare on FacebookGoogle+