Data -- Query Folders

Move Query Folder

Moves a query folder into another folder. path is the folder to move into ("/" for the project root); the moved folder keeps its name, so moving "/Reports" to "/Archive" gives "/Archive/Reports". All child folders and their paths are updated accordingly. Moving a folder into the folder it is already in changes nothing.

patch/data/projects/{projectId}/queries/folders/{folderId}/path

Request

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

Path parameters

projectIdstring required

ID of the Project

folderIdstring required

ID of the Query Folder to move

Request body

pathstring required

Path of the folder to move this folder into, or "/" for the project root. The moved folder keeps its name: moving "/Reports" to "/Archive" gives "/Archive/Reports". Folders missing along the path are created.

Example request

{
  "path": "/Archive"
}

Response

Folder 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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Monthly Reports",
  "path": "/reports/monthly",
  "parentId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-15T10:30:00Z"
}

Changes

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