Data -- Query Folders

Get Query Folder Tree

Returns the folder hierarchy as a tree structure. Optionally includes queries within each folder node. Use rootFolderId to get a subtree starting from a specific folder.

get/data/projects/{projectId}/queries/folders/tree

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/folders/tree
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the Project

Query parameters

includeQueriesboolean

Whether to include queries within each folder node

rootFolderIdstring

ID of the root folder to start the subtree from

Response

Folder tree retrieved successfully

Example response

{
  "tree": [
    {
      "queries": [
        {
          "schedule": {
            "type": "cron",
            "cronExpression": "0 0 * * *",
            "timezone": "UTC"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.