otonomo-docs

Test Drive Vehicle Data from Otonomo

Our connected car data is now accessible for developers

Creating reports

Introduction

There are two ways to create reports on Otonomo's data platform: via the report APIs and via the data consumer UI. The latter is covered by this document. For more information on report creation via API, use the following guide: Aggregated Data APIs

Creating reports via the UI is a great way to issue reports for those who prefer not to code.
Developers may also find the UI useful as it provides a code snippet of the API call used for generating the report, which can save development time.

To generate a report using the UI, follow these steps:

  1. Login to the platform: market.otonomo.io
  2. Select the required Workspace on which you wish to create reports.
  3. Click the Create Report button, see below:

When you click on Create Report, a drop-down with two options is displayed:

  1. 'Draw on map': used for generating a report for a specific area by drawing a 'polygon' on a map.
  2. 'By location': used for generating a report based on pre-defined filters: country & state.

🚧

Workspaces which are in Test mode can not use the report generation users interface.

To switch a Workspace from Test mode to Production mode, contact our sales team at [email protected]

Draw on map method

Below is a screenshot of the report creation screen when using the 'Draw on map' method.

Parameters description:

  1. Data Set - There are 3 data sets available:
    1. Points - Each row in the resulted file describe a unique point in time.
    2. Trips - Each row in the resulted file describes a unique trip
    3. Road Signs - Each row in the resulted file describes a road sign
  2. Start Time
  3. End Time
  4. Countries - Determines which country should be included in the report.
    The list includes only countries that were configured for the Workspace.
    'Draw on map' report generation form:
  5. Polygon - A polygon which will be used to filter results.

📘

Using more than 1 polygon

Creating a report via the UI is limited to 1 polygon per report.
To create a report with more than a single polygon, create the report via our API - Aggregated Raw Data

How to create the polygon?

  1. Find the location in which you want to draw the polygon by searching it in the search bar.
  2. Start drawing the polygon by pressing the blue polygon button on the bottom left
  1. Keep adding points to your polygon until you covered the required area.
    The polygon needs to have a minimum of 3 points.
  2. When finished drawing the polygon, press on one of the blue dots to exit the drawing mode.
  1. You can edit the existing polygon by dragging any of the blue dots in any direction.
    If additional points are required in the polygon, you will have to delete the current polygon and create a new one.
    To delete a polygon, use the red delete button:
  1. You are now ready to create your report.
    To start the report generation, press the blue "Generate" button on the bottom right corner.

Once the request for a report has been submitted, we will work on generating your report.
You can see the status of the report in the "Reports" section.

In the API section you are provided with the actual API used to create the report, so it can be used to generate future reports.
To use it again, you will only need to modify the start date and end date.

You can copy the resulted API command by using the copy button:

By location method

Below is a screenshot of the report creation screen when using the 'by location' method.

Parameters description:

  1. Data Set - There are 3 data sets available:
    1. Points - Each row in the resulted file describe a unique point in time.
    2. Trips - Each row in the resulted file describes a unique trip
    3. Road Signs - Each row in the resulted file describes a road sign
  2. Start Time
  3. End Time
  4. Countries - Determines which countries should be included in the report.
    The list includes only countries that were configured for the Workspace.
  5. US States - If the "United States" was chosen as a country, this filter will be available for use.
    If the "United States" wasn't chosen, this filter will be greyed out.

In the API section you are provided with the actual API used to create the report, so it can be used to generate future reports.
To use it again, you will only need to modify the start date and end date.

You can copy the resulted API command by using the copy button:

Once the parameters have been filled, you will be able to generate the report by pressing the "Generate" button in the bottom right corner.

Once the request for a report has been submitted, we will work on generating your report.
You can see the status of the report in the "Reports" section.

You are now ready to create and consume reports.
If you have any questions, please contact us at [email protected]

Updated about a month ago

Creating reports


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.