Plans
API overview

Analytics Tracking Plan

analytics-plan

Build a decision-first tracking plan — events, naming, funnels, quality checks — or audit your existing setup.

Pricing & runtime

Current price
25 Credits per run
Timeout
up to 900s
Brand Context
Optional — pass a brand_context_id

Prices are calibrated against real run costs and may change — the credit_cost returned when creating a run is authoritative.

Input parameters

Pass these under the input object of POST /api/v1/runs.

KeyTypeRequiredLabel & description
product_descriptionshort_textRequiredProductWhat the product is.
scopeselectOptionalScopeNew plan or audit.Options: New tracking plan, Audit existing setup
decisions_neededlong_textRequiredDecisions to serveThe questions your team must answer with data.
current_setuplong_textOptionalCurrent setupExisting events/properties and known gaps.
key_flowsshort_textOptionalKey flowsSignup, activation, purchase…
interaction_languageselectOptionalReport languageControls the language of the generated report.Options: English, Chinese

Request example

Covers every required field. Optional fields follow the same pattern.

curl -X POST https://api.TODO-APP-DOMAIN/api/v1/runs \
  -H "Authorization: Bearer $SUPAMARKETERS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_slug": "analytics-plan",
  "input": {
    "product_description": "example text",
    "decisions_needed": "example text"
  }
}'

What you get back

A 201 response returns run_no, credit_cost, stream_url and result_url (relative paths). Stream progress from stream_url and fetch the terminal result — summary and output — from result_url. Results stay available for the App's retention window (30 days by default).