User-defined reports
To create user-defined reports (formerly My Reports), you can use either the Platform UI or the GraphQL API. After creating a report template, you can schedule and retrieve reports using the GraphQL or REST API. The Platform UI and GraphQL API both let you generate custom templates by including or excluding metrics from standard templates or by building one from scratch.
The following table outlines the steps for generating reports.
| Step | Task | API | Notes |
|---|---|---|---|
| 1 | Create report templates. | GraphQL | You can also create templates in the platform UI and use the IDs to set up schedules in the API. |
| 2 | Set up report schedules. | GraphQL and REST | You can set a recurring schedule or generate a report immediately. |
FAQs
The following are frequently asked questions about report templates.
Can I use the REST API to create report templates?
No. You can use only the GraphQL API or platform UI to create report templates.
Can I use the report templates I created in the UI to set up schedules in the API?
Yes. You can also use the GraphQL and REST API to retrieve the report template IDs you created in the platform UI.