Marketplace
API Reference
Start typing to search…

List all data sets.

get
https://api.agrimetrics.co.uk/catalog/data-sets

List all data sets.

Query Params
ids
array of strings

List of data set ids

ids
creator
array of strings

The creator of the data set.

creator
keywords
array of objects
deprecated

Tags describing the data set. keywords is deprecated - use tags instead

keywords
tags
array of strings

Tags describing the data set.

tags
string
enum
deprecated

Note - This feature will no longer be available as we are in the process of moving to a different backend and will soon be removed. If provided, include data sets that have been tagged with concepts that are related to the values provided in the tags parameter. If not provided, only include data sets tagged with exact matches.

Allowed:
category
array of objects

Indicates the type of data

category
spatialCoverage
array of objects

The region the data is applicable to.

spatialCoverage
string
deprecated

Note - Use extendedText. This field has been deprecated. Free text search for data sets.

string

Free text search for data sets matching title; summary; description; tags; concepts; and source.

identities
array of strings

Only show datasets accessible by these identities. Can be 'PUBLIC', a user ID or an organisation ID.

identities
boolean

Defines whether to return only featured data sets

boolean

Defines whether datasets I own should be shown

boolean

Defines whether to show retired records

boolean

Defines whether to show archived records

boolean

Defines whether my editable data sets should be shown.

boolean

Defines whether hidden data sets should be shown.

integer
≥ 1

Set the page number. Should not be specified in conjunction with offset or limit.

integer
≥ 1

Set the page size. Should not be specified in conjunction with offset or limit.

integer
≥ 0

Set the pagination offset. Should not be specified in conjunction with pageNum or pageSize.

string
enum

Choose whether to search across all metadata on a data set, or just the title.

Allowed:
integer
≥ 1

Set the pagination limit. Should not be specified in conjunction with pageNum or pageSize.

boolean
deprecated

Note - This feature will no longer be available once we move to a different backend. "Format response to convert any new concepts to legacy concepts"

string
enum

Criterion by which to order the results

Allowed:
string
enum

The private data exchange for which to retrieve records

Allowed:
metadataStandardName
array of strings
metadataStandardName
metadataStandardVersion
array of strings
metadataStandardVersion
hierarchyLevel
array of strings
hierarchyLevel
draftStatus
array of objects
draftStatus
publishedStatus
array of objects
publishedStatus
licence
array of strings
licence
workflowKeywords
array of objects
workflowKeywords
taxonomyKeywords
array of strings
taxonomyKeywords
dataFormats
array of strings
dataFormats
revisiondaterange
object

The data set revision date range

metalastupdatedrange
object

The data set revision date range

owneremails
array of strings
owneremails
string of strings
string of strings
theme
array of strings
theme
valid
array of booleans

result of metadata validation

valid
serviceType
array of objects
serviceType
string
enum

Specifies format of the file if the repsonse is an xlsx spreadsheet

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Updated 7 months ago