REST-first integration
Connect keyword research, app analytics, competitor monitoring, and usage tracking through a single API surface.
API-reference
Integrér søgeordsresearch, app-analyse, rangeringer og optimerings-workflows via Appalize-motoren.
From analysis to an approved action
The assistant, API and MCP use the same operation registry. Discover what your account can access, inspect real data, then review the exact arguments of a proposed change.
1. Discover
Get the current input schema and required scopes. Follow nextOffset for additional results.
2. Read or prepare
Read operations return data. Other operations create an unapplied proposal with a 15-minute approval window.
3. Approve and verify
Approval executes the exact saved arguments. For queued work, check the job status separately.
HTTP · reviewed campaign change
# Discover the exact schema and required scopes
curl 'https://api.appalize.com/api/v1/operations?query=update_apple_ads_campaign&limit=5' \
-H "x-api-key: $APPALIZE_API_KEY"
# Prepare only. Replace 123 with a campaign ID you own.
curl 'https://api.appalize.com/api/v1/operations/run' \
-H "x-api-key: $APPALIZE_API_KEY" -H 'Content-Type: application/json' \
-d '{"operation":"update_apple_ads_campaign","arguments":{"campaignId":123,"dailyBudget":25}}'
# After human review, use the returned proposal ID. Do not invent an ID.
curl "https://api.appalize.com/api/v1/operations/proposals/$PROPOSAL_ID/commit" \
-H "x-api-key: $APPALIZE_API_KEY" -H 'Content-Type: application/json' \
-d '{"approved":true}'| State | Meaning and next step |
|---|---|
| approval_required / pending | No operation has run. Review the arguments and approve or cancel. Preparation is not a provider dry run. |
| running | Execution has started. Read this proposal again. A process interruption can leave it running; inspect the affected resource before doing anything else. |
| succeeded | The handler returned successfully. A dry run is still a dry run; a returned job ID is not a completed job. Inspect the result. |
| failed / uncertain | A failure or timeout may leave partial changes. Inspect the provider resource. Never automatically create another proposal. |
| cancelled / expired | A pending proposal was cancelled or its approval window expired. No new execution can start from it. |
Coverage and safety boundaries
Research keywords and competitors, inspect Apple Ads reports and bids, prepare metadata and review replies, manage releases, TestFlight, subscriptions and screenshot projects. Personal notes and notifications use separate workspace scopes. Plan entitlements, ownership and provider permissions still apply.
The proposal ID is the idempotency key, bound to the same identity and channel. A repeated commit returns its state without repeating execution. Records are retained for seven days; a missing record is never replayed. Credentials, OAuth, binary uploads and administrative access remain in dedicated trusted interfaces.
Existing named MCP write tools retain their original behavior and may apply immediately. Configure your MCP client to request human approval, or use the reviewed operation workflow. Appi itself has no commit tool: the user approves in the chat review card.
Use audit_seo_document to check supplied HTML and compare_keyword_coverage to compare supplied SEO or ASO keyword lists. These tools do not crawl websites, grant access to a customer's Google Search Console or guarantee indexing, traffic or rankings. Use verified first-party SEO data alongside Appalize research; save content plans as notes without publishing automatically.
Implementér på få minutter.
Følg vores trin-for-trin proces for at køre din første anmodning med en omfattende API-nøgle.
Need an API key first?
Generate one in the Appalize product at API Dashboard.
1
Create an API key inside the product app.
2
Use the `x-api-key` header on every request.
3
Start with keyword, app, and ranking endpoints before adding write operations.
Terminal
curl -X GET \
-H "x-api-key: YOUR_KEY" \
"https://api.appalize.com/api/v1/keywords/search?term=fitness"Key-scoped access
The API is designed around scoped keys so teams can expose only the capabilities each integration actually needs.
Interactive backend explorer
The public docs page can summarize the spec, while the backend host keeps the live Swagger explorer and raw OpenAPI JSON.
Recently updated integration paths.
These routes reflect the current public discovery, analytics ingestion, and billing-management flows now used by the product and public site.
Public discovery surfaces
Read-only endpoints powering app snapshots, search, sitemap pages, and compare routes on the public site.
GET
/api/public-apps/publicGET
/api/public-apps/searchGET
/api/public-apps/:platform/:slugGET
/api/public-apps/compare/:platform/:pairSlugInternal analytics ingestion
Collect client-side marketing and product events into Appalize revenue, funnel, and recent-sales dashboards.
POST
/api/analytics/eventsGET
/api/google-analytics/dashboardPOST
/api/analytics/web-vitalsBilling and managed checkout
Self-serve checkout, upgrade, and billing portal flows now resolve active subscribers into a management path instead of hard failing.
POST
/api/subscription/checkoutPOST
/api/subscription/upgradePOST
/api/subscription/stripe/billing-portalAPI-status og skema
Vores offentlige flade synkroniseres automatisk med vores interne mikrotjenester for at sikre, at dokumentationen aldrig afviger fra virkeligheden.
- Endepunktgrupper
- 1
- Operationer
- 6
Udforsk endepunktkategorier.
Hver gruppe repræsenterer et specialiseret domæne i Appalize-motoren.
Platform Operations
Specialized operations for platform operations workflows.
GET
/api/v1/operationsGET
/api/v1/operations/proposals/{proposalId}POST
/api/v1/operations/proposals/{proposalId}/cancelPOST
/api/v1/operations/proposals/{proposalId}/commitGET
/api/v1/operations/read/{operation}+ 1 flere operationer
Integrationsøkosystem
Udvid til AI-agent-workflows.
Gå ud over REST-kald. Forbind dine værktøjer direkte til Claude eller Cursor via vores Model Context Protocol-server.