Fetch Datasets By Query

GET 
/v1/search/datasets

Fetches datasets based on query parameters

Request

Query Parameters

search_term any

Search term to match on project name or description

Responses

200

Successful Response

application/json

Schema

Schema

results

object[]

A list of search results

Array [

project_id Project Id (string)required

Project ID

project_name Project Name (string)required

The name of this project

description Description (string)required

A description for this project.

total_datums_in_project Total Datums In Project (integer)required

Total datums in project.

created_timestamp date-timerequired

The timestamp this project was created.

nickname Nickname (string)required

The nickname who created this project.

thumbnail Thumbnail (string)required

The project display thumbnail.

slug Slug (string)required

The project url-safe slug

organization_slug Organization Slug (string)required

The organization url-safe slug

organization_name Organization Name (string)required

The organization nickname

creator_picture

object

The creator picture

anyOf

MOD1

string

projection_alias

object

The projection alias

anyOf

MOD1

string

tags

object

required

Tags associated with the project from dataset_tags table.

anyOf

MOD1

Array [

string

]

index_job_end_timestamp date-timerequired

The timestamp the map index job finished.

]

Example (from schema)

{
  "results": [
    {
      "project_id": "string",
      "project_name": "string",
      "description": "string",
      "total_datums_in_project": 0,
      "created_timestamp": "2024-07-29T15:51:28.071Z",
      "nickname": "string",
      "thumbnail": "string",
      "slug": "string",
      "organization_slug": "string",
      "organization_name": "string",
      "creator_picture": "string",
      "projection_alias": "string",
      "tags": [
        null
      ],
      "index_job_end_timestamp": "2024-07-29T15:51:28.071Z"
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...