Funnels API
Create saved funnels from scripts, setup tools, or internal dashboards.
Last updated June 3, 2026
Use the Funnels API to create the same saved funnel definitions available in the Conversions dashboard. Create an API key from Settings > API Keys, then send it as a bearer token.
Create API key
1curl https://usegrometrics.com/api/settings/api-keys \2-H "Content-Type: application/json" \3-b "grometrics_session=YOUR_SESSION_COOKIE" \4-d '{ "name": "Momenta setup" }'
POST /api/funnels
1curl https://usegrometrics.com/api/funnels \2-H "Authorization: Bearer YOUR_API_KEY" \3-H "Content-Type: application/json" \4-d '{5"name": "Momenta onboarding",6"conversionWindowSeconds": 1209600,7"steps": [8{ "type": "Screen view", "value": "Onboarding Hook" },9{ "type": "Screen view", "value": "Onboarding First Action" },10{ "type": "Screen view", "value": "Onboarding Paywall" },11{ "type": "Event", "value": "paywall_viewed" },12{ "type": "Event", "value": "trial_started" },13{ "type": "Event", "value": "onboarding_completed" }14]15}'
Options / Configuration
| Option | Type | Required | Description |
|---|---|---|---|
| name | string | ✓ | Saved funnel name, unique for the signed-in account |
| steps | array | ✓ | 2 to 10 ordered steps |
| steps[].type | string | ✓ | Pageview, Screen view, Goal, or Event |
| steps[].value | string | ✓ | Page path, screen name, saved goal name, or custom event name |
| conversionWindowSeconds | number or null | no | 3600, 86400, 604800, 1209600, 2592000, 7776000, or null |
What happens next
After creating a funnel, open Conversions and switch to Funnels to review drop-off, source breakdowns, and revenue after completion.
Troubleshooting
Request is unauthorized
Check that the Authorization header uses a valid, unrevoked Grometrics API key.
Screen step has no visitors
Confirm the mobile SDK sends the same screen value used in the funnel step.
Was this page helpful?