curl -X POST "https://api.orwel.io/api/v1/reports" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"dateFrom": "2026-10-01", "dateTo": "2026-10-31"}'
{
"data": {
"workspaceId": "770e8400-e29b-41d4-a716-446655440002",
"dateFrom": "2026-10-01",
"dateTo": "2026-10-31",
"generatedAt": "2026-11-04T16:18:37.149Z",
"metrics": {
"totalVisitors": 2140,
"totalLeads": 63,
"conversionRate": 2.94,
"avgLeadScore": 58
},
"leadQualityDistribution": { "high": 12, "medium": 30, "low": 15, "unknown": 6 },
"leadScoreDistribution": { "high": 14, "medium": 29, "low": 12, "unscored": 8 },
"conversionsByCode": { "generate_lead": 51, "book_demo": 12 },
"topLeads": [],
"trafficByCountry": { "MX": 1320, "US": 610 },
"lifecycleDistribution": { "anonymous": 1890, "lead": 63, "customer": 9, "churned": 0, "other": 0 },
"analysis": {
"executiveSummary": "October brought 63 leads from 2,140 visitors...",
"keyInsights": ["Most high score leads came from organic search"],
"actionPlan": ["Follow up the 12 high quality leads this week"],
"funnelAnalysis": "...",
"prospectHighlights": "..."
}
}
}
Reports
Generate Report
Build a report for a date range: visitors, leads, conversion rate, lead quality, top leads, traffic by country, plus a written summary and action plan.
POST
/
api
/
v1
/
reports
curl -X POST "https://api.orwel.io/api/v1/reports" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"dateFrom": "2026-10-01", "dateTo": "2026-10-31"}'
{
"data": {
"workspaceId": "770e8400-e29b-41d4-a716-446655440002",
"dateFrom": "2026-10-01",
"dateTo": "2026-10-31",
"generatedAt": "2026-11-04T16:18:37.149Z",
"metrics": {
"totalVisitors": 2140,
"totalLeads": 63,
"conversionRate": 2.94,
"avgLeadScore": 58
},
"leadQualityDistribution": { "high": 12, "medium": 30, "low": 15, "unknown": 6 },
"leadScoreDistribution": { "high": 14, "medium": 29, "low": 12, "unscored": 8 },
"conversionsByCode": { "generate_lead": 51, "book_demo": 12 },
"topLeads": [],
"trafficByCountry": { "MX": 1320, "US": 610 },
"lifecycleDistribution": { "anonymous": 1890, "lead": 63, "customer": 9, "churned": 0, "other": 0 },
"analysis": {
"executiveSummary": "October brought 63 leads from 2,140 visitors...",
"keyInsights": ["Most high score leads came from organic search"],
"actionPlan": ["Follow up the 12 high quality leads this week"],
"funnelAnalysis": "...",
"prospectHighlights": "..."
}
}
}
Requires an API key (
orwel_sk_) with all three scopes: leads:read, visitors:read and conversions:read.Body
string
required
Start of the range, ISO 8601 (
2026-10-01)string
required
End of the range, ISO 8601 (
2026-10-31)string
Optional. When sent it must be the key’s own workspace; any other value returns
403 forbidden.Response
object
Show Report
Show Report
object
totalVisitors, totalLeads, conversionRate and avgLeadScore for the rangeobject
Leads by quality:
high, medium, low, unknownobject
Leads by score:
high (70 to 100), medium (40 to 69), low (0 to 39), unscoredobject
Number of conversions per conversion code
array
Best leads of the range with name, email, quality, score, source, location and lifecycle stage
object
Visitors per country
object
Identities by stage:
anonymous, lead, customer, churned, otherobject
Written analysis:
executiveSummary, keyInsights (array), actionPlan (array), funnelAnalysis, prospectHighlightsErrors
| Status | error | When |
|---|---|---|
400 | bad_request | The body is not JSON, dateFrom or dateTo is missing, or a date is not ISO 8601. |
403 | insufficient_scope | The key is missing one of the three scopes. |
403 | forbidden | workspaceId is not the key’s workspace. |
curl -X POST "https://api.orwel.io/api/v1/reports" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"dateFrom": "2026-10-01", "dateTo": "2026-10-31"}'
{
"data": {
"workspaceId": "770e8400-e29b-41d4-a716-446655440002",
"dateFrom": "2026-10-01",
"dateTo": "2026-10-31",
"generatedAt": "2026-11-04T16:18:37.149Z",
"metrics": {
"totalVisitors": 2140,
"totalLeads": 63,
"conversionRate": 2.94,
"avgLeadScore": 58
},
"leadQualityDistribution": { "high": 12, "medium": 30, "low": 15, "unknown": 6 },
"leadScoreDistribution": { "high": 14, "medium": 29, "low": 12, "unscored": 8 },
"conversionsByCode": { "generate_lead": 51, "book_demo": 12 },
"topLeads": [],
"trafficByCountry": { "MX": 1320, "US": 610 },
"lifecycleDistribution": { "anonymous": 1890, "lead": 63, "customer": 9, "churned": 0, "other": 0 },
"analysis": {
"executiveSummary": "October brought 63 leads from 2,140 visitors...",
"keyInsights": ["Most high score leads came from organic search"],
"actionPlan": ["Follow up the 12 high quality leads this week"],
"funnelAnalysis": "...",
"prospectHighlights": "..."
}
}
}