List sessions

Example request:

Example response:

200
{
  "code": 0,
  "data": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 1,
    "records": [
      {
        "id": "dataset-dasfadsgadsgas",
        "name": "mysql",
        "description": "mysql databases"
      }
    ]
  }
}

Authorizations

x-pd-api-key

string

header

required

Headers

x-pd-external-trace-id

string

The trace ID you set in your system to trace this request. It can be up to 128 characters in length. If the request fails, you can provide it to the Powerdrill team to help with troubleshooting.

Query Parameters

page_number

integer

default:

The page number to start listing. If not specified, the default value 1 will be used.

page_size

integer

default:

The number of items on a single page. If not specified, the default value 10 will be used.

string

The search keyword, which can be up to 128 characters in length. Sessions with names containing this keyword will be listed.

If omitted, all sessions created by you will be listed.

user_id

string

required

Your user ID, which uniquely identifies you within your team. To obtain your ID:

If you're the team admin, refer to Check user information.
If you're a system or virtual user, ask your team admin to check your user ID by referring to Check user information.

Response

200 - application/json

code

integer

required

Status code. 0 indicates that the operation is successful. Otherwise, the operation fails. For error troubleshooting, refer to Error Codes.

data

object

required

A paginated list of sessions.

Overview

Datasets

Data sources

Files

Sessions

Jobs

Authorizations

Headers

Query Parameters

Response