Data -- Query Folders

Add/Remove Queries In/From Folder

Moves queries into or out of a folder. Queries in queryIdsAdded are moved to the folder's path. Queries in queryIdsRemoved that are in this folder are moved to root ("/"); ids that are not in this folder are ignored. If a query cannot be moved (for example it does not exist), the request fails with that error and the moves before it stay applied.

put/data/projects/{projectId}/queries/folders/{folderId}

Request

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

Path parameters

projectIdstring required

ID of the Project

folderIdstring required

ID of the Query Folder

Request body

queryIdsAddedstring[]
queryIdsRemovedstring[]

Response

Queries moved successfully

idstring

Unique identifier of the folder (UUID)

namestring

Display name of the folder

pathstring

Full path of the folder in the hierarchy

parentIdstring

ID of the parent folder, null if root-level

createdAtstring

Timestamp when the folder was created (ISO 8601)

Example response

{
  "folders": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Monthly Reports",
      "path": "/reports/monthly",
      "parentId": "550e8400-e29b-41d4-a716-446655440001",
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "queries": [
    {
      "schedule": {
        "type": "cron",
        "cronExpression": "0 0 * * *",
        "timezone": "UTC"
      }
    }
  ]
}

Changes

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