API reference · Runs

Category report

Ask a question about a kind of app ("what do users hate about calorie trackers") and Appleak reads the charting apps’ reviews, ranks what users want and complain about, and writes the answer. Takes 10–45 minutes; the job’s result is the whole report.

POST/api/v1/reports

Costs: 10 credits
MCP tool: start_category_report
Answers: A job, at once (202)

curl "https://appleak.app/api/v1/reports" \
  -H "Authorization: Bearer $APPLEAK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "what do users hate about meditation apps",
    "scope": "both"
  }'

Response202 Accepted

{
  "id": "6f1c2b9e-1d0a-4c55-9a51-2b7f0c3e8d41",
  "object": "job",
  "kind": "report",
  "status": "queued",
  "credits": 10,
  "refunded": false,
  "progress": null,
  "createdAt": "2026-10-19T12:00:00.000Z",
  "startedAt": null,
  "finishedAt": null,
  "error": null,
  "result": null,
  "links": {
    "self": "/api/v1/jobs/6f1c2b9e-1d0a-4c55-9a51-2b7f0c3e8d41"
  }
}

#Parameters

Body parameters

questionstringrequired
The question, about a kind of app. 3–400 characters
scope"both" | "apple" | "play"optionaldefault "both"
Which stores to read.
countrystringoptionaldefault "us"
Two-letter storefront code, e.g. us, gb, de.
daysintegeroptional
How many days of reviews to read. The default is the report’s own. 7–365
forcebooleanoptional
Start a new run even when the same one is already queued or running for you.

#Returns

A job, straight away, with status queued. Follow it with GET /jobs/{id} until it is done; the finished job carries the result.

MCP: start_category_report — Start an Appleak category report: reads the reviews of the charting apps of a kind (e.g. "meditation apps") and answers a question about what users want and hate. Spends credits and takes 10–45 minutes; returns a job id — call get_job to follow it.