Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Introduction

This page explains to exporting a query data using the APIsTo export query data using APIs and obtain a CSV file, a two-step process is required. First, you'll utilize an API to initiate the query export, and then another API to download the resulting CSV file.

  1. Initiating query export API: This API initiates the export process. It allows you to specify the query data you want to export and sets up the necessary parameters for the export operation.

  2. Download CSV API: Once the export is scheduled, this API enables you to retrieve the exported CSV file containing the queried data. It completes the export process by providing you with a downloadable link or directly fetching the file.

We've provided a sample code for utilizing these APIs daily. By examining this code, you can seamlessly integrate it into your preferred programming language.

Exporting query data

Method

POST

URL

http[s]://<server_url>/rest/ng/query/export

Body

Code Block
{
    "drivingForm": "<DRIVING_FORM>",
    "cpId": <CP_ID>,
    "aql": "<AQL>",
    "wideRowMode": "<DEEP/SHALLOW/OFF>"
}

Response

Code Block
{
  "dataFile": "query_0_61e59bc2-9350-47db-9af8-a1e7a3b65bc2",
  "completed": false
}

...