Run an App Audit - prioritised ASO actions, metadata rewrites and findings with evidence (first one free).
curl --request POST \
--url https://api.appgoat.ai/v1/apps/{app}/audit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"country": "us",
"mode": "full",
"wait": true,
"fresh": false,
"free_only": false,
"white_label": false,
"label": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
country: 'us',
mode: 'full',
wait: true,
fresh: false,
free_only: false,
white_label: false,
label: '<string>'
})
};
fetch('https://api.appgoat.ai/v1/apps/{app}/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/apps/{app}/audit"
payload = {
"country": "us",
"mode": "full",
"wait": True,
"fresh": False,
"free_only": False,
"white_label": False,
"label": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "aud_3fK9aQ2mXc81LpRt",
"slug": "<string>",
"url": "<string>",
"status": "queued",
"store": "apple",
"app_id": "<string>",
"country": "<string>",
"mode": "full",
"title": "<string>",
"icon_url": "<string>",
"score": 123,
"white_label": true,
"branding": {
"brand_name": "<string>",
"logo_url": "<string>",
"accent_color": "#1f6feb",
"cta_url": "<string>",
"cta_text": "<string>",
"footer": "<string>",
"powered_by": true
},
"label": "<string>",
"report": {
"score": 50,
"headline": "<string>",
"summary": "<string>",
"sections": [
{
"section": "<string>",
"title": "<string>",
"body": "<string>",
"finding_ids": [
"<string>"
]
}
],
"actions": [
{
"title": "<string>",
"why": "<string>",
"how": "<string>",
"impact": "high",
"effort": "low",
"finding_ids": [
"<string>"
],
"playbook": "<string>"
}
],
"metadata": [
{
"field": "title",
"current": "<string>",
"suggested": "<string>",
"chars": 123,
"limit": 123,
"rationale": "<string>"
}
],
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"narrative": "opus",
"model": "<string>",
"generated_at": "2023-11-07T05:31:56Z"
},
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"facts": {},
"credits_charged": 123,
"free": true,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_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>"
]
}
}{
"data": {
"id": "aud_3fK9aQ2mXc81LpRt",
"slug": "<string>",
"url": "<string>",
"status": "queued",
"store": "apple",
"app_id": "<string>",
"country": "<string>",
"mode": "full",
"title": "<string>",
"icon_url": "<string>",
"score": 123,
"white_label": true,
"branding": {
"brand_name": "<string>",
"logo_url": "<string>",
"accent_color": "#1f6feb",
"cta_url": "<string>",
"cta_text": "<string>",
"footer": "<string>",
"powered_by": true
},
"label": "<string>",
"report": {
"score": 50,
"headline": "<string>",
"summary": "<string>",
"sections": [
{
"section": "<string>",
"title": "<string>",
"body": "<string>",
"finding_ids": [
"<string>"
]
}
],
"actions": [
{
"title": "<string>",
"why": "<string>",
"how": "<string>",
"impact": "high",
"effort": "low",
"finding_ids": [
"<string>"
],
"playbook": "<string>"
}
],
"metadata": [
{
"field": "title",
"current": "<string>",
"suggested": "<string>",
"chars": 123,
"limit": 123,
"rationale": "<string>"
}
],
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"narrative": "opus",
"model": "<string>",
"generated_at": "2023-11-07T05:31:56Z"
},
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"facts": {},
"credits_charged": 123,
"free": true,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_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"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}Audits
Run App Audit
Refreshes the listing, tags recent reviews, probes ~20 search terms (popularity, difficulty, the app’s
rank, relevance), compares competitors, then writes a prioritised report: report.actions (what to do
first, with the evidence and a playbook), report.metadata (title / subtitle / keyword-field rewrites
within the character limits) and report.findings (deterministic checks with numbers). Every statement
in the narrative is checked against the measured facts; unsupported ones are dropped.
Takes 1-3 minutes: with wait=true (default) the call blocks up to ~25 s, then answers 202 with the audit
id; poll GET /v1/audits/{id} (free). The shareable page is url (appgoat.ai/r/…, not indexed).
An audit of the same app, country and mode from the last 24 h is returned again for 0 credits unless
fresh=true.
Failed audits are never charged: one that fails within wait costs 0, one that fails after the 202 is
refunded automatically (the refund shows on the same request in your usage logs).
POST
/
apps
/
{app}
/
audit
Run an App Audit - prioritised ASO actions, metadata rewrites and findings with evidence (first one free).
curl --request POST \
--url https://api.appgoat.ai/v1/apps/{app}/audit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"country": "us",
"mode": "full",
"wait": true,
"fresh": false,
"free_only": false,
"white_label": false,
"label": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
country: 'us',
mode: 'full',
wait: true,
fresh: false,
free_only: false,
white_label: false,
label: '<string>'
})
};
fetch('https://api.appgoat.ai/v1/apps/{app}/audit', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.appgoat.ai/v1/apps/{app}/audit"
payload = {
"country": "us",
"mode": "full",
"wait": True,
"fresh": False,
"free_only": False,
"white_label": False,
"label": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "aud_3fK9aQ2mXc81LpRt",
"slug": "<string>",
"url": "<string>",
"status": "queued",
"store": "apple",
"app_id": "<string>",
"country": "<string>",
"mode": "full",
"title": "<string>",
"icon_url": "<string>",
"score": 123,
"white_label": true,
"branding": {
"brand_name": "<string>",
"logo_url": "<string>",
"accent_color": "#1f6feb",
"cta_url": "<string>",
"cta_text": "<string>",
"footer": "<string>",
"powered_by": true
},
"label": "<string>",
"report": {
"score": 50,
"headline": "<string>",
"summary": "<string>",
"sections": [
{
"section": "<string>",
"title": "<string>",
"body": "<string>",
"finding_ids": [
"<string>"
]
}
],
"actions": [
{
"title": "<string>",
"why": "<string>",
"how": "<string>",
"impact": "high",
"effort": "low",
"finding_ids": [
"<string>"
],
"playbook": "<string>"
}
],
"metadata": [
{
"field": "title",
"current": "<string>",
"suggested": "<string>",
"chars": 123,
"limit": 123,
"rationale": "<string>"
}
],
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"narrative": "opus",
"model": "<string>",
"generated_at": "2023-11-07T05:31:56Z"
},
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"facts": {},
"credits_charged": 123,
"free": true,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_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>"
]
}
}{
"data": {
"id": "aud_3fK9aQ2mXc81LpRt",
"slug": "<string>",
"url": "<string>",
"status": "queued",
"store": "apple",
"app_id": "<string>",
"country": "<string>",
"mode": "full",
"title": "<string>",
"icon_url": "<string>",
"score": 123,
"white_label": true,
"branding": {
"brand_name": "<string>",
"logo_url": "<string>",
"accent_color": "#1f6feb",
"cta_url": "<string>",
"cta_text": "<string>",
"footer": "<string>",
"powered_by": true
},
"label": "<string>",
"report": {
"score": 50,
"headline": "<string>",
"summary": "<string>",
"sections": [
{
"section": "<string>",
"title": "<string>",
"body": "<string>",
"finding_ids": [
"<string>"
]
}
],
"actions": [
{
"title": "<string>",
"why": "<string>",
"how": "<string>",
"impact": "high",
"effort": "low",
"finding_ids": [
"<string>"
],
"playbook": "<string>"
}
],
"metadata": [
{
"field": "title",
"current": "<string>",
"suggested": "<string>",
"chars": 123,
"limit": 123,
"rationale": "<string>"
}
],
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"narrative": "opus",
"model": "<string>",
"generated_at": "2023-11-07T05:31:56Z"
},
"findings": [
{
"id": "<string>",
"type": "striking_distance",
"section": "metadata",
"severity": "high",
"title": "#14 for \"habit tracker adhd\" (not in the title or subtitle)",
"evidence": {},
"fix": "<string>",
"playbook": "<string>"
}
],
"facts": {},
"credits_charged": 123,
"free": true,
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"finished_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"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"hint": "<string>",
"docs": "<string>",
"param": "<string>"
}
}Authorizations
Create a key at https://dash.appgoat.ai.
Path Parameters
Any app identifier: App Store id (284882215, id284882215), Play package (com.spotify.music), Apple bundle id (com.spotify.client), store URL (URL-encoded), apple:<id> / play:<id>, or a name (spotify).
Example:
"com.spotify.music"
Query Parameters
Disambiguates {app} (a bundle id vs a Play package, or a name).
Available options:
apple, play Body
application/json
One storefront.
lite = cached data, fewer reviews and keywords (cheaper and faster for us; same price).
Available options:
full, lite Run again even if a recent audit exists.
Only run when it is the free first audit (402 free_audit_used otherwise).
Studio: the report page carries your branding (brand name, logo, accent colour, CTA, footer; set them in the dashboard under Settings → Report branding) instead of AppGoat's. 402 plan_limit on other plans. Re-using a recent audit applies the branding to it for 0 credits.
Your label for the audit list, e.g. the client or prospect name.
Maximum string length:
80