PPC and SEO Rank Tracking API Documentation (v1)

Add and manage keywords programmatically to our weekly SEO and PPC rank tracking platform for Google and Bing.

Authentication

Basic Auth Token

Security scheme type:	HTTP
HTTP Authorization Scheme	basic

api_key

Secret Key Authentication

Security scheme type:	API Key
Query parameter name:	api_key

WeeklyTrackingApi

View and manage your weekly keyword tracking groups/terms.

Get list of groups by name

get /get_groups

https://www.spyfu.com:80/apis/WeeklyTracking_Api/get_groups

query Parameters

listName	string Name of group list
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/get_groups?api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "-8280301796433908807",
- "domainName": "spyfu.com",
- "listId": "2af68ab7-2f6b-47de-9659-52ab0d0a4fef",
- "listName": "BoomBam",
- "listType": "PPC"
}

]

Get list of groups by domain

get /get_groups_by_domain

https://www.spyfu.com:80/apis/WeeklyTracking_Api/get_groups_by_domain

query Parameters

domainName required	string Domain query
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/get_groups_by_domain?domainName=spyfu.com&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "domainId": "-8280301796433908807",
- "domainName": "spyfu.com",
- "listId": "2af68ab7-2f6b-47de-9659-52ab0d0a4fef",
- "listName": "BoomBam",
- "listType": "PPC"
}

]

Get list of terms by list ID

get /get_terms

https://www.spyfu.com:80/apis/WeeklyTracking_Api/get_terms

query Parameters

listId required	string List ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/get_terms?listId=LIST_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

[

{
- "bing_Ad_History_Overview": -2147483648,
- "bing_Ad_Position": -2147483648,
- "bing_Ad_Position_Change": -2147483648,
- "bing_Extracted_Hour": 2017031923,
- "bing_Organic_History_Overview": -2147483648,
- "bing_Organic_Position": -2147483648,
- "bing_Organic_Position_Change": -2147483648,
- "bing_Search_Date_Id": 20170319,
- "google_Ad_History_Overview": -2147483648,
- "google_Ad_Position": -2147483648,
- "google_Ad_Position_Change": -2147483648,
- "google_Extracted_Hour": 2017032103,
- "google_Organic_History_Overview": 99099,
- "google_Organic_Position": 1,
- "google_Organic_Position_Change": 0,
- "google_Search_Date_Id": 20170319,
- "keyword": "keyword groupie",
- "last_Checked_Bing": "3/19/2017 11:00:00 PM",
- "last_Checked_Google": "3/21/2017 3:00:00 AM",
- "term_Id": 25564552
}

]

Add terms to group

get /add_terms

https://www.spyfu.com:80/apis/WeeklyTracking_Api/add_terms

query Parameters

groupName required	string Name of group
domainName required	string Domain query
isSeo required	string Flag for organic tracking
isPpc required	string Flag for paid tracking
keywordCsv required	string 64-base encoded comma separated keywords to add
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/add_terms?groupName=slippers&domainName=spyfu.com&isSeo=true&isPpc=false&keywordCsv=YnVubnkgc2xpcHBlcnMsZnV6enkgYnVubnkgc2xpcHBlcnMsZmx1ZmZ5IGJ1bm55IHNsaXBwZXJz&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"Add Successful."

Delete term from group

get /delete_term

https://www.spyfu.com:80/apis/WeeklyTracking_Api/delete_term

query Parameters

domainId required	string Domain ID
termId required	string Term ID
listId required	string List ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/delete_term?domainId=-8280301796433908807&termId=2300426&listId=LIST_GUID&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"Delete Successful."

Delete group list

get /delete_group

https://www.spyfu.com:80/apis/WeeklyTracking_Api/delete_group

query Parameters

domainId required	string Domain ID
listId required	string List ID
isSeo required	boolean Flag for organic vs paid terms
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/delete_group?domainId=-8280301796433908807&listId=LIST_GUID&isSeo=true&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

"Delete Successful."

Get term metrics

get /get_term_data

https://www.spyfu.com:80/apis/WeeklyTracking_Api/get_term_data

query Parameters

isSeo required	string Flag for organic vs paid terms
domainId required	string Domain ID
termId required	string Term ID
api_key	string User's secret key

Responses

200

500

InternalServerError

Request samples

cURL
JS
C#
PHP

Copy

curl "https://www.spyfu.com/apis/weeklytracking_api/get_term_data?isSeo=true&domainId=-8280301796433908807&termId=2300426&api_key=SECRET_KEY"

Response samples

Content type

Copy

Expand all Collapse all

{

"keyword": null,
"keywords":
[
- {
  - "ad_Url": null,
  - "body": null,
  - "extracted_Hour": null,
  - "position": 0,
  - "search_Date_Id": 0,
  - "search_Engine": null,
  - "title": null
  }
],
"last_Checked_Bing": null,
"last_Checked_Google": null,
"termId": 0,
"message": null,
"success": true,
"redirect_url": null,
"resultCount": 0

}