Skip to main content
Reporting covers the three ways data comes back out: running a report, recording and querying analytics events, and downloading a bulk export. It exists because reading at scale has different constraints from reading one record — some answers are aggregates, and some datasets are too large to page through.

​
Reports

Reports come in two kinds, and they behave differently. Built-in reports are read-only and addressed by a string key such as totalContacts; custom reports are ones you create, addressed by an ID, with the full create, update and delete cycle. Either kind returns its configuration separately from its rows, so you can see what a report contains before paying the cost of running it. They exist to answer questions across your data without querying it directly. See Reporting in the Help Center.

​
Analytics

Analytics is two endpoints meant to be called from the browser: identify creates or updates a contact from a set of traits, and track records events against that contact — page views, clicks, form completions. They exist so client-side activity can be attributed to a person, and they are the only endpoints a Client-safe key can reach, so a public page can send them without exposing full API access. See ConveYour Analytics with JavaScript in the Help Center.

​
Exports

An export is a file ConveYour generates in the background for a dataset too large to page through an API. These endpoints do not create exports — you start one in the app, then use the API to poll its status and download it once ready. They exist so bulk data can leave ConveYour without holding a request open while the file is built.