Exporting data from the API to CSV
JD avatar
Written by JD
Updated over a week ago

The API can be used to get data that is otherwise not available through Uptick's typical user experience. This article will guide you through the process of navigating to an API endpoint and exporting the data into CSV file.

Navigating to the endpoint and exporting the CSV

The following steps apply to any data you're looking for. This example involves getting a list of past service dates which are recorded against service tasks, so you need to navigate to the service tasks endpoint then take the appropriate steps to export the data to a CSV file.

  1. Add /api/v2 after your Uptick domain address to access the Uptick API page. The address should look something like this:
    Note: If certain information does not appear for you, you can try again and adding the minor version number after the major version number (i.e. v2.7). You can check the latest version updates on the Uptick API article.

  2. From here you will see a list of endpoints, labelled by their object type (i.e. servicetasks) with a URL next to it. Click the appropriate URL to access your chosen endpoint.

  3. Add /generate_csv/ to the end of the current URL in your browser's address bar and hit the Enter key to initiate the generation of the CSV. The status will display PENDING, denoting that the CSV is in the process of being generated.

  4. Wait a short while, then refresh the page. The status will change to GENERATED once the file is ready to download, and the link to download will be in the resulting block of text.
    Note: If the status hasn't changed, that means the CSV is still being generated and may need some more time to complete. Refresh again after waiting until the status changes.

  5. Look for where it says "url": The next block of text after this will have the download URL for the CSV. Copy everything between the quotes, up to and including Expires=number.

  6. Paste what you've copied into your browser's address bar and hit the Enter key. One of the following should occur:

    • If your browser is configured to automatically download to a default folder, the file should automatically download to that location OR

    • You will be prompted to browse your computer to choose where the file be will be saved, then save it.

  7. You can now open the CSV to find what you're looking for (in this case the data in the Performed Date column) and filter out anything you don't want.

Did this answer your question?