List datasets for the current customer | Dadosfera AutoDriveDDF API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

List every dataset that belongs to your account.
Useful to:

  • Build dashboards of ingestion volumes.
  • Locate a dataset_id for follow-up queries.
  • Audit status (processing, success, failed, …).

HTTP Request

GET /datasets
(no path parameters)



Authentication

In your REST client (Postman/Insomnia), select Basic Auth and enter your Username and Password.

The client will automatically generate the Authorization: Basic … header for you. Do not add that header manually.



Request Headers

HeaderExampleRequiredNotes
AuthorizationBasic YWRtaW46bXlwYXNzd29yZA==HTTP Basic Auth – always use HTTPS.
Acceptapplication/jsonGuarantees JSON response.

Query Parameters

NameTypeDefaultDescription
limitinteger20Page size (max = 100).
offsetinteger0Number of datasets to skip (for pagination).
namestringCase-insensitive substring match on the dataset’s name.
statusstringFilter by status: success, processing, failed, updating.

Example Request (cURL)

curl -u admin:mypassword \
     "https://api.autodriveddf.example/datasets?limit=50&status=success"

Success Response 200 OK

[
  {
    "dataset_id": "c8004e22-87f7-441f-8302-80c934841196",
    "id": 31,
    "name": "platform_knowledge_base",
    "status": "success",
    "status_reason": null,
    "customer_name": "dadosferaDemo",
    "instance_id": "78b9e8c0-a123-4e56-9f01-abcdef123456",
    "created_at": "2025-05-04T14:46:58.802Z",
    "updated_at": "2025-06-12T11:20:03.441Z"
  },
  {
    "dataset_id": "d1f2c3b4-1111-2222-3333-444455556666",
    "id": 32,
    "name": "analytics_logs",
    "status": "processing",
    "status_reason": null,
    "customer_name": "dadosferaDemo",
    "instance_id": "78b9e8c0-a123-4e56-9f01-abcdef123456",
    "created_at": "2025-06-10T09:00:00.000Z",
    "updated_at": "2025-06-10T09:00:00.000Z"
  }
]
FieldDescription
dataset_idCanonical UUID – use this for subsequent API calls.
idInternal numeric identifier (rarely needed).
nameHuman-friendly dataset name.
statussuccess, processing, failed, or updating.
status_reasonNon-null only if status = failed.
customer_nameTenant / account identifier.
instance_idInternal processing instance (audit/debug).
created_atDataset creation timestamp (ISO-8601).
updated_atLast time files were added or status changed.

Error Responses

CodeReasonWhen it happensExample Body
401UnauthorizedMissing / wrong Basic Auth credentials
400Bad RequestMalformed query parameter (e.g., non-integer limit){ "detail": "limit must be a positive int." }
500Server ErrorUnexpected issue while fetching dataset list{ "detail": "Unexpected error." }

Pagination Workflow

Use limit + offset to paginate:

GET /datasets?limit=50&offset=0     → first 50
GET /datasets?limit=50&offset=50    → next 50
Query Params
string

Filter by dataset name

integer
1 to 100
Defaults to 20

Max results per page

integer
≥ 0
Defaults to 0

Results to skip for pagination

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json