Skip to main content
GET
Run a report

Authorizations

Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Path Parameters

id
string
required
read-only

ID or token of the report to run 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

Query Parameters

start
string<date-time>
required

limit events counted in report to those recorded at or after this time

end
string<date-time>
required

limit events counted in report to those recorded at or before this time

Response

200 - application/json

OK

name
string

Required name of the report. Must be unique within the account: creating or renaming a report onto a name another report already uses is rejected with HTTP 422. Leading and trailing whitespace is stripped before the name is stored.

description
string

optional extra description

columns
Report Column · object[]

Array of report columns

rules
object[]

rules to match events to include

group_by
string[]

group results by these event properties

token
string

identifier used for sharing

created_at
string<date-time>
read-only

Time report was created

updated_at
string<date-time>
read-only

Time report was last updated