A report is a named definition of criteria (columns, rules, group_bys) which is stored. A stored report can be run for a given timeframe, producing the report results. The results are a count of the events for each column in that timeframe that match the rules and which are optionally grouped by event properties.
Reports can be shared outside LeadConduit such that anyone who has the
URL to the shared report can view it without authentication. Each
shared report URL contains a generated, unique, unguessable token,
which is stored as a property in the report definition. To create the
token for a report, use the share
endpoint. To stop sharing a report,
use the unshare
endpoint, which will clear the token.'
name | string required name of the report |
description | string optional extra description |
Array of objects (Report Column) Array of report columns | |
Array of objects (ReportRule) rules to match events to include | |
group_by | Array of strings group results by these event properties |
token | string identifier used for sharing |
created_at | string <date-time> (Timestamp) Time report was created |
updated_at | string <date-time> (Timestamp) Time report was last updated |
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
The /events/stats
resource is used to count events. The event count can be grouped by any field collected
with the lead or appended to the lead during flow processing. The API also supports returning results in JSON
or CSV using the appropriate MIME type in the Accept
header.
OK
[- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
]
[- {
- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Create a new report, adding it to the list of all reports in the account.
Create a new Report
created
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get the report definition for an individual report. The parameter can be a report id, which requires passing the api_key or a report token, which does not.
OK
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update an existing report. Note that the token cannot be updated with
this call. Use the /share endpoint to generate a new token and /unshare
to clear it.
Update an existing report
created
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Create a report but don't save it. The report definition is provided in the post body and the time range is provided as query parameters.
OK
[- {
- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Run a report that was previously created. The parameter can be an id or token. The time range is provided as query parameters.
OK
[- {
- "name": "string",
- "description": "string",
- "columns": [
- {
- "source-submitted": 0,
- "source-success": 0,
- "source-failure": 0,
- "source-error": 0,
- "recipient-submitted": 0,
- "recipient-success": 0,
- "recipient-failure": 0,
- "recipient-error": 0,
- "return-received-submitted": 0,
- "return-received-success": 0,
- "return-received-failure": 0,
- "return-received-error": 0,
- "return-sent-submitted": 0,
- "return-sent-success": 0,
- "return-sent-failure": 0,
- "return-sent-error": 0,
- "conversion-received-submitted": 0,
- "conversion-received-success": 0,
- "conversion-received-failure": 0,
- "conversion-received-error": 0,
- "conversion-sent-submitted": 0,
- "conversion-sent-success": 0,
- "conversion-sent-failure": 0,
- "conversion-sent-error": 0,
- "ping-submitted": 0,
- "ping-success": 0,
- "ping-success-rate": 0,
- "ping-win-rate": 0,
- "cost": 0,
- "revenue": 0,
- "profit": 0,
- "cost-per-conversion-received-success": 0,
- "avg-cost-per-lead": 0,
- "avg-revenue-per-lead": 0
}
], - "rules": [
- {
- "lhv": null,
- "op": "is equal to",
- "rhv": null
}
], - "group_by": [
- "string"
], - "token": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]