All reports are GET requests under https://api.corvidae.ai/reporting. See Getting Started with the Corvidae API for sign-in, dates, filters and errors.
Access: API key means the report works with an X-API-Key header or a signed-in user token. Token only means it needs a signed-in user token and rejects API keys.
Common parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
|
integer |
The company to report on. You must have access to it. |
|
|
date ( |
The period, inclusive. Each report states which format. |
|
|
integer[] |
Only these conversion types. Repeat the parameter. Omit for all. |
|
|
integer[] |
Only these sites or apps. Repeat the parameter. Omit for all. |
|
|
integer |
Attribution model. Omit for the company's default. |
|
|
text |
One of |
Paid channels: Affiliate, Display, Native, PaidSearch, PaidSocial, Aggregator. Organic channels: Direct, Email, OrganicSearch, OrganicSocial, Referral.
Which report answers which question
|
Question |
Report |
|---|---|
|
How is each channel performing day by day? |
Channel performance, Daily performance |
|
How much revenue is paid versus organic? |
Channel contribution |
|
Which campaigns, sources or referrers drive revenue? |
Primary dimensions, Referrers |
|
How do our numbers compare with the ad platform? |
AdTech campaigns |
|
How does the attribution model change channel credit? |
Model comparison |
|
Who introduces, influences and closes sales? |
IIC |
|
How do we compare with Google Analytics? |
Google comparison |
|
What paths do customers take before converting? |
Journeys |
|
Where, on what device and when do customers convert? |
Audience reports |
|
Did a campaign change cause extra conversions? |
Incrementality, Experiments |
Report index
|
Area |
Report |
Path |
Access |
|---|---|---|---|
|
Channels |
Channel performance |
|
API key |
|
|
Daily performance |
|
API key |
|
|
Channel contribution |
|
API key |
|
Traffic |
Traffic |
|
API key |
|
Campaigns |
Primary dimensions |
|
API key |
|
|
AdTech campaigns |
|
API key |
|
|
Referrers |
|
API key |
|
Audience |
Cities |
|
API key |
|
|
Devices |
|
API key |
|
|
Weekdays |
|
API key |
|
|
Hours |
|
API key |
|
Attribution |
Model comparison |
|
API key |
|
|
IIC |
|
API key |
|
|
Google comparison |
|
API key |
|
|
Journeys |
|
API key |
|
|
Path length |
|
Token only |
|
|
Paths table |
|
Token only |
|
Raw data |
Raw transactions |
|
API key |
|
Conversion types |
List, create |
|
Token only |
|
Experiments |
Experiments, daily revenue |
|
Token only |
|
Incrementality |
Comparisons and results |
|
Token only |
Channel reports
GET /api/v2/channels/performance
Daily visits, unique visitors, conversions, revenue and impressions, with totals for the period. Use it to chart how a channel, or all channels, is trending.
|
Parameter |
Required |
Notes |
|---|---|---|
|
|
Yes |
|
|
|
Yes |
|
|
|
No |
Omit for all channels. |
|
|
No |
|
|
|
No |
Only this campaign. |
{
"totalVisitCount": 0,
"totalUniqueVisitorCount": 0,
"totalConversionCount": 0.0,
"totalRevenue": 0.0,
"totalImpressionsCount": 0,
"dailyData": [
{ "date": "2026-01-01T00:00:00", "visitCount": 0, "uniqueVisitorCount": 0,
"conversionCount": 0.0, "revenue": 0.0, "impressionsCount": 0 }
]
}
The totals are the sums of the daily rows, so a visitor who returns on several days is counted once per day in totalUniqueVisitorCount.
GET /api/v2/channels/dailyPerformance
Attributed revenue per day, split by channel. Use it for a stacked revenue-over-time chart.
Parameters: companyId, startDate, endDate (date-time) required; conversionTypeIds, digitalPropertyIds, campaignId, modelId optional.
Response: one item per channel: { "channel", "totalRevenue", "dailyData": [{ "date", "revenue" }] }.
GET /api/v2/channels/contribution
Each channel's revenue as an amount and a percentage, rolled up into Paid and Organic groups.
Parameters: companyId, startDate, endDate (date-time) required; conversionTypeIds, digitalPropertyIds, modelId optional.
Response: array of { "group", "channel", "revenue", "revenuePercent", "groupRevenue", "groupRevenuePercent" }. revenuePercent is the channel's share of total revenue. groupRevenuePercent is its share of its Paid or Organic group.
GET /api/v2/traffic
The same daily figures as channel performance, for all channels combined, using the company's default attribution model.
Parameters: companyId, startDate, endDate (yyyy-MM-dd) required; conversionTypeIds, digitalPropertyIds optional. Response: same shape as channel performance.
Campaign and source reports
GET /api/v2/primarydimensions
Performance ranked by campaign, source or referrer.
Parameters: companyId, primaryDimension (Campaign, Source or Referrer), startDate, endDate (date-time) required; channelType, conversionTypeIds, digitalPropertyIds, modelId optional.
Response: array of { "primaryDimension", "revenue", "conversionCount", "visitCount", "uniqueVisitorCount" }, where primaryDimension is the name.
GET /api/v2/adtechcampaigns
Compares what Corvidae attributes to each campaign with what the ad platform (for example Google Ads or Meta) reports, including spend and budget. Use it to spot where the two disagree.
Parameters: companyId, startDate, endDate (date-time) required; channelType, conversionTypeIds, digitalPropertyIds, uniqueCampaignId, modelId optional.
Response: one item per campaign.
|
Group |
Fields |
|---|---|
|
Corvidae |
|
|
Ad platform |
|
|
Differences |
|
roas is revenue divided by spend and cpa is spend divided by conversions. Both are 0 when there is no spend or no conversions. The adTech fields are empty for campaigns with no linked ad platform campaign.
GET /api/v2/referrers
Clicks, revenue and conversions for each referring site, with its channel.
Parameters: companyId, startDate, endDate (yyyy-MM-dd) required; conversionTypeIds, digitalPropertyIds optional. Response: array of { "referrer", "channel", "clicks", "revenue", "conversions" }.
Audience reports
Who converts, where, on what and when. All four take companyId, startDate, endDate (yyyy-MM-dd) as required and conversionTypeIds, digitalPropertyIds as optional, and use the company's default attribution model.
|
Report |
Shows |
Response item |
|---|---|---|
|
|
Revenue by customer city |
|
|
|
Revenue by device operating system |
|
|
|
Revenue, conversions, visits and impressions per day of the week |
|
|
|
The same, per hour of each day (for a heatmap) |
|
dayOfWeek is Monday to Sunday. Location is available at city level only.
Attribution reports
GET /api/v2/modelcomparison
Revenue credited to each channel under each attribution model, side by side.
Parameters: companyId, startDate, endDate (yyyy-MM-dd) required; conversionTypeIds, digitalPropertyIds optional.
Response: totals per model (customerConversionTotal, newCustomerDiscoveryTotal, timeDecayZipfsDecayTotal, firstClickTotal, lastClickTotal, linearClickTotal, timeDecayTotal) and items[], one per channel, with channelName and a revenue value per model.
GET /api/v2/iic
Introducer, influencer and closer analysis: what typically starts customer journeys, assists along the way, or finishes them, and the revenue credited at that stage.
Parameters: companyId, startDate, endDate (yyyy-MM-dd), aggBy (campaign, channel, referer or source), stage (introducer, influencer or closer) required; conversionTypeIds optional.
Response: { "totalRevenue", "totalConversions", "totalRevenuePerConversion", "items": [{ "channel", "campaign", "source", "revenue", "conversions", "revenuePerConversion" }] }.
GET /api/v2/google/comparison
Compares revenue attributed by Corvidae with revenue reported by Google Analytics, per channel and in total.
Parameters: companyId, startDate, endDate (date-time) required.
Response: { "report": [{ "channel", "channelGroup", "revenue", "googleRevenue" }], "totalRevenue", "totalGoogleRevenue" }. revenue is Corvidae-attributed.
GET /api/v1/journeys
The most common customer paths to conversion: ordered channels (optionally with source and campaign), with the conversions and revenue each path produced.
|
Parameter |
Required |
Notes |
|---|---|---|
|
|
Yes |
|
|
|
Yes |
|
|
|
No |
Paths that include any of these. |
|
|
No |
Paths whose first touchpoint matches. |
|
|
No |
Paths whose last touchpoint matches. |
|
|
No |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
Response: { "totalConversions", "totalRevenue", "paths": [{ "conversions", "revenue", "items": [{ "channel", "source", "campaign", "revenuePercentage" }] }] }. revenuePercentage is the share of the path's revenue credited to that step.
Raw data
GET /api/v2/rawtransactions
Individual transactions for a company and period, for reconciliation or export.
Parameters: companyId, startDate, endDate (yyyy-MM-dd) required. Response: array of { "dateTime", "transactionId", "revenue", "shipping", "tax" }.
Reports that need a signed-in user token
These reject API keys. They are used by the Corvidae app and by applications acting for a signed-in user.
Path length: GET /vla/pathsLength
Path-length statistics before and after visitor identity stitching, including single-touch journeys. Parameters: companyId, startDate, endDate (yyyy-MM-dd) required; conversionTypeIds optional.
Paths table: GET /vla/pathsTable
Conversion paths for a chosen attribution model, with conversions, revenue and the revenue split across steps. Parameters: companyId, startDate, endDate, model required; channelType, sourceType, campaignType, conversionTypeIds, campaignId optional. Response: array of { "conversions", "revenue", "attributes": [{ "channel", "source", "campaign", "revenuePercentage" }] }.
Conversion types: /api/v1/companies/{companyId}/conversionTypes
The named events (for example a purchase or sign-up) that reports can be filtered by. The id returned is what you pass as conversionTypeIds.
|
Method |
Purpose |
Body or response |
|---|---|---|
|
|
List the company's conversion types. |
|
|
|
Create one. |
|
Experiments: /api/v1/experiments
Control-versus-trial results for campaign experiments, comparing Corvidae-attributed and ad platform results. Both reports take companyId, startDate, endDate (date-time) required and conversionTypeIds, digitalPropertyIds, modelId optional.
-
GET /api/v1/experimentsreturns one entry per experiment, with a combined row, a control row and a trial row, a ROAS chart, the revenue difference and an annualised projection. -
GET /api/v1/experiments/dailyrevenuereturns control and trial revenue per day plus percentage differences in revenue, conversions, media spend and CPA.
Units differ within a response. Control and trial rows hold absolute values. The combined row and the *Difference fields are percentage differences of trial relative to control, (trial - control) / control x 100, or 0 when control is zero. The exception is totalRevenueDifference, an absolute amount.
Incrementality: /api/incrementality/comparisons
Attribution answers which touchpoints get credit for conversions that happened. Incrementality answers how many extra conversions the advertising caused, by comparing a control group of campaigns with an experiment group.
-
List the company's campaigns and conversion actions with
GET /campaignConversionActions?companyId=. -
Create a comparison with a control group and an experiment group, each made of campaign and conversion action pairs, and a start date.
-
Fetch the results to see uplift, the change in CPA and ROAS, daily trends and an annualised projection.
|
Call |
Purpose |
|---|---|
|
|
Campaigns and the conversion actions each has. |
|
|
Create a comparison. Returns |
|
|
List comparisons with a headline summary (conversion and revenue uplift, CPA and ROAS change). |
|
|
One comparison with its groups. |
|
|
Replace a comparison (same body as create). |
|
|
Delete a comparison. |
|
|
The calculated results. |
Create and update body:
{
"companyId": 0,
"name": "string",
"startDate": "2026-01-01T00:00:00Z",
"endDate": null,
"controlGroup": { "groupName": "Control", "rows": [{ "campaignId": 0, "conversionActionId": 0 }] },
"experimentGroup": { "groupName": "Experiment", "rows": [{ "campaignId": 0, "conversionActionId": 0 }] }
}
endDate is optional; leave it out for an open-ended comparison. A missing comparison returns 404, and invalid input returns 400 with a message.
The results include totals for each group, the uplift (conversionUpliftPercent, revenueUpliftPercent), differences in spend, conversions and revenue (experiment minus control), CPA and ROAS, per-action figures, an annualised projection, daily trends and per-campaign figures. Uplift, CPA and ROAS are empty when the value they are divided by is zero.