curl -i -X GET \ https://app.leadconduit.com/reports
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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"
], - "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"
], - "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.
required | object (Report) ID or token of the report to fetch |
OK
curl -i -X GET \ https://app.leadconduit.com/reports/:id
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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.
required | object (Report) ID or token of the report to fetch |
Update an existing report
created
{- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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"
], - "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"
}
]
Delete an existing report.
required | object (Report) ID or token of the report to delete |
OK
curl -i -X DELETE \ https://app.leadconduit.com/reports/:id
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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
curl -i -X POST \ 'https://app.leadconduit.com/reports/preview?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&columns=source-submitted'
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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.
required | object (Report) ID or token of the report to run |
OK
curl -i -X GET \ 'https://app.leadconduit.com/reports/:id/run?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z'
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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 metadata for a report that was shared.
required | object (ReportMeta) Token of the report to retrieve metadata for |
OK
curl -i -X GET \ https://app.leadconduit.com/reports/:token/meta
[- {
- "name": "string",
- "description": "string",
- "columns": [
- "source-submitted"
], - "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"
}
]