List data in view

List every dataset the session's viewport offers (layers, tables, documents, scanned maps): the same list the Ploti map shows for this view and zoom, unranked, as titles. Use it when find_data doesn't find what you need or you are unsure it found the right thing. Rows (type, title, id, and a lock with what opens it) come grouped by place: the view's own places first, then state and national data. The header counts everything in view by place, category and type. Narrow it with types or categories to what the question needs, then page with offset until no next offset is given; leaving them out lists everything, which in a dense view runs to many pages. Pass ids from the rows to read those datasets in detail: description, category and how to read each. Then check a few rows (tools.schema, SQL) or a document's sections before using one.

post/v1/tools/list_data_in_view

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/tools/list_data_in_view
  • Auth: HTTP bearer

Request body

sessionIdstring required

The id start_session returned. Lost it? get_session without an id lists this workspace's open sessions.

typesstring[]

Kinds of data to keep: map layers queried with SQL, tables, documents (ordinances, plans, reports) or scanned maps. Every kind when left out.

categoriesstring[]

Dataset categories to keep (zoning, hazards, and so on), spelled as the listing's header names them; every category when left out.

idsstring[]

Dataset ids from the listing, or layer ids from find_data, to read in detail.

limitinteger

Rows per page; 300 when left out. Narrowing types or categories usually beats a bigger page.

offsetinteger

Where the page starts: the next offset the previous page reported, or the first row when left out. Ignored with ids.

Response

What the tool returned: its text, any images, and structured data.

textstring required
dataunknown

Changes

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