Skip to main content
GET /v1/aso/brief/:appId
Returns a decision-oriented package for ASO: it runs the same work as a full ASO audit and keyword opportunities in parallel, adds a storefront readiness score (creative + metadata + ASO blend), optionally semantic intent clusters on opportunity keywords, and supports multi-country briefs. Use the individual endpoints when you need full raw reports. Details on intent clustering: ASO Intent Clusters.

Path parameters

NameTypeRequiredDescription
appIdstringYesApple App ID (numeric)

Query parameters

NameTypeDefaultDescription
countrystringusISO country code (ignored when countries is set)
countriesstringComma-separated ISO codes (e.g. us,gb,de) for per-country briefs; see multi-country below
freshboolfalseIf true or 1, forces a fresh re-analysis (slower)
intentClustersboolfalseIf true or 1, group opportunity keywords into semantic intent clusters (+2 credits)

Response (single country)

SectionDescription
summaryOne-line headline, ASO score, grade, keyword stats
storefrontReadiness0–100 combined score: ASO core, creative (visuals + screenshot count from audit), metadata fit; gradeLabel + summary
intentClustersPresent when intentClusters=1: clusters with label, keywords, avgOpportunityScore, prioritizeClusterId, or skipped + reason if clustering cannot be returned
prioritizedActionsAudit + opportunities + optional intent action (“Prioritize this intent group…”)
opportunitiesTopUp to 10 opportunity rows
metawarnings if clustering skipped or failed

Multi-country

Use ?countries=us,gb,de (same rules as keyword ranks / countries list).
Response shape:
{
  "data": {
    "appId": "913335252",
    "countries": ["de", "gb", "us"],
    "results": {
      "us": { "...": "same shape as single-country brief" },
      "gb": { },
      "de": { }
    }
  }
}
Credits: base 5 × number of countries in countries (minimum 1). +2 when intentClusters=1 (flat add-on for the whole request).

Code examples

# Single storefront + optional intent clusters
curl "https://api.appeeky.com/v1/aso/brief/913335252?country=us&intentClusters=1" \
  -H "X-API-Key: YOUR_API_KEY"

# Multi-country
curl "https://api.appeeky.com/v1/aso/brief/913335252?countries=us,gb,de" \
  -H "X-API-Key: YOUR_API_KEY"

Credits

  • 5 × (country multiplier) — multiplier is the number of valid countries codes, or 1 when only country is used (same model as keyword metrics / ranks).
  • +2 when intentClusters=1 (intent clustering add-on).
See Rate limits. Response header X-Credit-Cost reflects the final charge.

Errors

StatusCodeWhen
400INVALID_APP_IDMissing or non-numeric app ID
400INVALID_COUNTRIEScountries set but no valid codes
404APP_NOT_FOUNDApp unavailable or no data for a requested country
401Missing or invalid API key
429Insufficient monthly credits

MCP: aso_brief — use countries and intent_clusters arguments. See MCP Server.