nexqdata/ docs

Managing datasets

List your stored datasets, share them, export several at once, save queries, and delete what you don't need.

Every dataset has one id, the datasetId. You get it from a job or run, or from the list below. The endpoints on this page all take that id.

List your datasets

GET/api/scraper-agents/cached-exports

Everything stored for you, plus datasets your company shares with you. The list is paged by page number.

Query parameterDefaultDescription
qSearch.
statusallAvailable, Failed, Stale, or Expired.
scopeallJob or Run — whether the dataset holds a whole job's data or one run's.
sectionproductiondemo lists datasets from demo agents instead.
page, pageSize1, 25pageSize up to 100.
FieldMeaning
idThe datasetId.
agentName, scraperAgentIdThe agent that collected it.
agentJobHistoryId, agentRunHistoryId, groupRunIdThe job, run, and group run it came from.
status, sizeBytes, fileNameWhether it's downloadable, how big it is, and its file name.
expiresAt, isExpiredWhen retention removes the file, and whether it already has. The record stays after the file is gone.
accessLevel, canManagePrivate or Company, and whether you can change or delete it.

The page also reports availableCount and totalBytes across the whole filtered list.

Where a dataset came from

GET/api/data-explorer/datasets/{datasetId}/lineage

The dataset's origin as a small graph: nodes (the agent, the job or run, and the dataset itself) and the edges between them.

Share with your company

A dataset is Private to the user who collected it until it's shared. Sharing makes it visible to everyone in your company.

GET/api/data-explorer/datasets/{datasetId}/access
PUT/api/data-explorer/datasets/{datasetId}/access
Request body
{ "accessLevel": "Company" }

accessLevel is Private or Company. Only the dataset's owner can change it, and sharing needs your account to belong to a company — otherwise you get 400 INVALID_ACCESS_POLICY.

Export several at once

POST/api/data-explorer/bulk/export
Request body
{ "datasetIds": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }

Up to 50 datasets, streamed back as one zip. The X-Export-File-Count header says how many files it holds. Datasets whose files aren't available are left out; if none are, you get 404 DATASETS_NOT_FOUND.

One bulk export runs at a time per account and company. A second one returns 429 BULK_EXPORT_CAPACITY_EXCEEDED with Retry-After: 5.

Saved queries

Save a query to run again later. Saved queries are private to you.

EndpointDoes
GET /api/data-explorer/saved-queriesYour saved queries, newest first (up to 100).
POST /api/data-explorer/saved-queriesSave one: { "name": "...", "datasetId": "...", "definition": { ... } }. definition is a query request body.
DELETE /api/data-explorer/saved-queries/{id}Delete one.

Delete datasets

DELETE/api/scraper-agents/cached-exports/{datasetId}
POST/api/data-explorer/bulk/delete

The bulk form takes { "datasetIds": [...] } (up to 50) and returns processed and skipped counts. You can delete only datasets you own; others are skipped.

Deleting removes the stored copy

The stored file and any saved queries on it are deleted. The run itself stays in your history.

On this page