Socrata Open Data: Socrata Describe Dataset

Read a dataset’s schema, column types, and freshness metadata.

Tool ID: socrata_describe_dataset

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe socrata_describe_dataset --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "id": "id_123",
    "name": "Example",
    "description": "Example description"
  }
}

Use deepline describe socrata_describe_dataset --json for the latest machine-readable contract.

Input reference

Read a dataset’s schema, column types, and freshness metadata

Name	Type	Required	Default	Details
`payload.datasetId`	`string`	Yes	—	The dataset 4x4 identifier, e.g. `ipu4-2q9a`. Pattern: `^[a-z0-9]{4}-[a-z0-9]{4}$`.
`payload.domain`	`string`	Yes	—	Socrata host for this dataset, e.g. `data.cityofnewyork.us`. Routed at runtime. Not sent upstream as a query parameter.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.id`	`string`	No	—	—
`result.data.name`	`string`	No	—	—
`result.data.description`	`string`	No	—	—
`result.data.rowsUpdatedAt`	`integer`	No	—	—
`result.data.columns`	`array`	No	—	—
`result.data.columns[].fieldName`	`string`	No	—	—
`result.data.columns[].name`	`string`	No	—	—
`result.data.columns[].dataTypeName`	`string`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation