Start tracking search ranks for keywords (daily re-rank; idempotent).
curl --request POST \
--url https://api.appgoat.ai/v1/tracked-keywords \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"terms": [
"photo editor",
"collage maker"
],
"store": "both",
"countries": [
"us",
"gb"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: ['photo editor', 'collage maker'],
store: 'both',
countries: ['us', 'gb']
})
};
fetch('https://api.appgoat.ai/v1/tracked-keywords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/tracked-keywords"
payload = {
"terms": ["photo editor", "collage maker"],
"store": "both",
"countries": ["us", "gb"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"id": 123,
"store": "apple",
"country": "<string>",
"term": "<string>",
"created": true
}
],
"meta": {
"credits_used": 123,
"credits_remaining": 123,
"request_id": "<string>",
"freshness": {
"fetched_at": "2023-11-07T05:31:56Z",
"age_seconds": 123,
"stale": true,
"refreshing": true,
"job_id": "<string>"
},
"next_cursor": "<string>",
"store": "apple",
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "invalid_param",
"message": "limit must be ≤ 100",
"hint": "Fix the parameter and retry.",
"docs": "https://appgoat.ai/docs/errors#invalid_param",
"param": "limit"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}Keywords
Track keywords
deprecated
Each (term × store × country) uses one keyword slot of your plan; a request that would exceed it tracks nothing and returns 402 plan_limit.
POST
/
tracked-keywords
Start tracking search ranks for keywords (daily re-rank; idempotent).
curl --request POST \
--url https://api.appgoat.ai/v1/tracked-keywords \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"terms": [
"photo editor",
"collage maker"
],
"store": "both",
"countries": [
"us",
"gb"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: ['photo editor', 'collage maker'],
store: 'both',
countries: ['us', 'gb']
})
};
fetch('https://api.appgoat.ai/v1/tracked-keywords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/tracked-keywords"
payload = {
"terms": ["photo editor", "collage maker"],
"store": "both",
"countries": ["us", "gb"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"id": 123,
"store": "apple",
"country": "<string>",
"term": "<string>",
"created": true
}
],
"meta": {
"credits_used": 123,
"credits_remaining": 123,
"request_id": "<string>",
"freshness": {
"fetched_at": "2023-11-07T05:31:56Z",
"age_seconds": 123,
"stale": true,
"refreshing": true,
"job_id": "<string>"
},
"next_cursor": "<string>",
"store": "apple",
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "invalid_param",
"message": "limit must be ≤ 100",
"hint": "Fix the parameter and retry.",
"docs": "https://appgoat.ai/docs/errors#invalid_param",
"param": "limit"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}Authorizations
Create a key at https://dash.appgoat.ai.
Body
application/json
Available options:
apple, play, both Maximum array length:
500How many results to keep per ranking (default 100 Apple / 50 Play).
Minutes between re-ranks (paid plans can go below 1440).