List your watches (apps, competitor sets, keyword sets) with usage against your plan's limits.
curl --request GET \
--url https://api.appgoat.ai/v1/watches \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.appgoat.ai/v1/watches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/watches"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": 123,
"kind": "app",
"name": "<string>",
"store": "apple",
"app": {
"store": "apple",
"app_id": "<string>",
"title": "<string>",
"icon_url": "<string>",
"developer_name": "<string>"
},
"competitors": [
{
"store": "apple",
"app_id": "<string>",
"title": "<string>",
"icon_url": "<string>",
"developer_name": "<string>"
}
],
"terms": [
"<string>"
],
"keywords": [
{
"id": 123,
"term": "<string>",
"store": "apple",
"country": "<string>",
"ranked_at": "2023-11-07T05:31:56Z"
}
],
"countries": [
"<string>"
],
"event_types": [
"new_version"
],
"settings": {
"significance": 0.5,
"rank_move": 5,
"keyword_top_n": 10,
"chart_top_n": 100,
"rating_drop": 0.1,
"spike_factor": 3,
"email_digest": true,
"depth": 123,
"cadence_minutes": 123
},
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"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"
}
}Watches & events
List watches
meta.usage has watched apps and keyword slots used vs your plan (null limit = unlimited).
GET
/
watches
List your watches (apps, competitor sets, keyword sets) with usage against your plan's limits.
curl --request GET \
--url https://api.appgoat.ai/v1/watches \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.appgoat.ai/v1/watches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/watches"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": 123,
"kind": "app",
"name": "<string>",
"store": "apple",
"app": {
"store": "apple",
"app_id": "<string>",
"title": "<string>",
"icon_url": "<string>",
"developer_name": "<string>"
},
"competitors": [
{
"store": "apple",
"app_id": "<string>",
"title": "<string>",
"icon_url": "<string>",
"developer_name": "<string>"
}
],
"terms": [
"<string>"
],
"keywords": [
{
"id": 123,
"term": "<string>",
"store": "apple",
"country": "<string>",
"ranked_at": "2023-11-07T05:31:56Z"
}
],
"countries": [
"<string>"
],
"event_types": [
"new_version"
],
"settings": {
"significance": 0.5,
"rank_move": 5,
"keyword_top_n": 10,
"chart_top_n": 100,
"rating_drop": 0.1,
"spike_factor": 3,
"email_digest": true,
"depth": 123,
"cadence_minutes": 123
},
"active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"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"
}
}Authorizations
Create a key at https://dash.appgoat.ai.
Query Parameters
Available options:
app, keyword, competitor_set Only watches that include this app (any {app} input).
Disambiguates {app} (a bundle id vs a Play package, or a name).
Available options:
apple, play