Introduction

The EU Pollinator Hub is an integrative tool to centralise, analyse and visualise bee and pollinator-related data based on principles of collaboration and conservation.
Bees and other insect pollinators are becoming increasingly relevant in the public debate. European authorities now recognise the environmental risks pollinators face and the need for institutional action. Given their importance for ecosystems and their role in our food security, the commitment to protect pollinators has been growing, and data is essential to fulfilling this commitment.
Different agents and stakeholders are continually collecting data related to the status of pollinators, such as researchers, environmental, health or agricultural authorities, national beekeeping or farming associations. The EU Pollinator Hub has been conceived to valorise their efforts and improve collaborations based on data-sharing. At the same time, the EU Pollinator Hub is constantly developing to provide access to valuable data from different consenting sources. In a collaborative spirit, the EU Pollinator Hub centralises and presents this data, also working as a communicative tool for the benefit of bees and pollinators in general.
The EU Pollinator Hub is coordinated by BeeLife European Beekeeping Coordination, an NGO focused on the protection of pollinators and biodiversity in Europe. BeeLife has initialised the first stages of this integrative platform within the Internet of Bees (IoBee) project.
The EU Pollinator Hub is also an attempt to materialise the conclusions of the EU Bee Partnership regarding the need for further bee-data integration. The partnership is a stakeholder platform dynamised by the European Food Safety Authority that includes representatives from the beekeeping and farming sectors, NGOs, veterinarians, academia, industry, producers, and scientists.
This new tool also includes developments from the Apimondia working group on the standardisation of data on bees - Bee XML. Bee XML is the ongoing measure to reach a new model for sharing bee data, and the EU Pollinator Hub aims at implementing these standards.

Base URL: https://app.pollinatorhub.eu

This documentation aims to provide all the information you need to work with our API.

Warning! This API is still under active development and is not the final version. It also may contain bugs and issues, which should be reported to EUPH issue management.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking API Tokens.

Discovery

Publicly accessible routes, that do not require any special permissions.

Pipeline health check

requires authentication

Tests whether the API functions according to expectations. Should return "status": "OK" when successful.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/status';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/status'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *


{
    "status": "OK"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List datasets

requires authentication

Get a list of all publicly accessible datasets. Does not return all fields contained within the dataset. Only returns datasets with completely integrated data. Note, list contains publicly inaccessible datasets as well (see attribute public). Uses pagination.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=1&limit=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/discovery/datasets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'page' => '1',
            'limit' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/discovery/datasets"
);

const params = {
    "page": "1",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/discovery/datasets'
params = {
  'page': '1',
  'limit': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

Show headers

cache-control: cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "uid": "CNTRS2.0.0",
            "name": "Countries",
            "longName": "EUPH reference dataset containing names and codes of countries, aggregates and subdivisions of countries",
            "status": "publish",
            "public": false,
            "licence": "EU Pollinator Hub",
            "published_at": "2023-01-25T23:00:00.000000Z",
            "id": 2,
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2024-01-26T17:32:58.000000Z"
        },
        {
            "uid": "LNGGE20.0.0",
            "name": "Language",
            "longName": "Partial content of ISO 639 containing information on languages",
            "status": "publish",
            "public": false,
            "licence": "EU Pollinator Hub",
            "published_at": "2023-03-22T23:00:00.000000Z",
            "id": 20,
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2024-01-26T17:32:58.000000Z"
        },
        {
            "uid": "PHRFR27.0.0",
            "name": "EUPH Reference licences",
            "longName": "List of licences by which datasets are published on the EU Pollinator Hub",
            "status": "publish",
            "public": false,
            "licence": "CC BY 4.0",
            "published_at": "2023-03-27T22:00:00.000000Z",
            "id": 27,
            "created_at": "2023-09-01T08:53:39.000000Z",
            "updated_at": "2024-02-01T14:25:03.000000Z"
        }
    ],
    "first_page_url": "https://pollinatorhub/api/v1/discovery/datasets?page=1",
    "from": 1,
    "last_page": 3,
    "last_page_url": "https://pollinatorhub/api/v1/discovery/datasets?page=3",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/datasets?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/datasets?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/datasets?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/datasets?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://pollinatorhub/api/v1/discovery/datasets?page=2",
    "path": "https://pollinatorhub/api/v1/discovery/datasets",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 9
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/discovery/datasets

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

Query Parameters

page integer optional

Load specified page to view the results. Default: 1 Example: 1

limit integer optional

Set the amount of results the API returns. Up to 1000. Default: 100 Example: 3

Response

Response Fields

data object[]

A list of Datasets available to the User.example email address, url or other.

* object

uid string

The unique identifier used to identify the entity within the platform.

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

status string

The status of the dataset. The list of available status are the following: draft, pending, reject, reviewing, pending-peer-rev, peer-reviewing, publish, publish-with-pw, trash, hidden

public boolean

1 means that the data of this dataset are public.

licence string|null

The uid of the licence of this entity.

published_at string|null

The date and time the dataset was published.

created_at string

The date and time the dataset was created.

updated_at string

The date and time the dataset was last updated.

Show dataset

requires authentication

Get detailed information about specific dataset.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/discovery/datasets/NUTSA3.0.0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/discovery/datasets/NUTSA3.0.0';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/discovery/datasets/NUTSA3.0.0"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/discovery/datasets/NUTSA3.0.0'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers

cache-control: cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *


{
    "data": {
        "uid": "NUTSA3.0.0",
        "name": "NUTS 2021",
        "longName": "Nomenclature of territorial units for statistics, version 2021, valid from 1 January 2021",
        "description": "The dataset contains the nomenclature of territorial units for statistics (NUTS), a classification set up by Eurostat as a single, coherent system for dividing up the EU's territory in order to produce regional statistics for the Community. The legal basis for NUTS is Regulation (EC) No 1059/2003 of the European Parliament and of the Council of 26 May 2003 on the establishment of a common classification of territorial units for statistics (NUTS). \n\nNUTS version 2021 has been developed on the basis of the sixth amendment to the annexes, that was adopted by Commission Delegated Regulation 2019/1755, entered into force on 2019-08-08 and applied, with regard to the transmission of data to the Commission (Eurostat), from 2021-01-01. To meet the demand for statistics at a local level, Eurostat maintains a system of Local Administrative Units (LAUs) compatible with NUTS. In addition, since some data collections use postcodes to reference the geographic location, Eurostat has established a link between postcodes and NUTS level 3 codes in order to exploit information which originally is coded only by postcodes.",
        "status": "publish",
        "public": true,
        "licence": {
            "uid": "eurostat",
            "name": "Eurostat",
            "abbreviation": "Eurostat",
            "description": "Eurostat has a policy of encouraging free re-use of its data, both for non-commercial and commercial purposes. All statistical data, metadata, content of web pages or other dissemination tools, official publications and other documents published on its website, with the exceptions listed below, can be reused without any payment or written licence provided that:\n\n* the source is indicated as Eurostat;\n* when re-use involves modifications to the data or text, this must be stated clearly to the end user of the information.\n\n# Exceptions\n\n1. The permission granted above does not extend to any material whose copyright is identified as belonging to a third-party, such as photos or illustrations from copyright holders other than the European Union. In these circumstances, authorisation must be obtained from the relevant copyright holder(s).\n2. Logos and trademarks are excluded from the above mentioned general permission, except if they are redistributed as an integral part of a Eurostat publication and if the publication is redistributed unchanged.\n3. When reuse involves translations of publications or modifications to the data or text, this must be stated clearly to the end user of the information. A disclaimer regarding the non-responsibility of Eurostat shall be included.\n4. The following Eurostat data and documents may not be reused for commercial purposes (but non-commercial reuse is possible without restriction):\n\ta. Data identified as belonging to sources other than Eurostat; all data published on Eurostat's website can be regarded as belonging to Eurostat for the purpose of their reuse, with the exceptions stated below, or if it is explicitly stated otherwise.\n\tb. Publications or documents where the copyright belongs partly or wholly to other organisations, for example concerning co-publications between Eurostat and other publishers.\n\tc. Data on countries other than\n        - Member States of the European Union (EU), and\n        - Member States of the European Free Trade Association (EFTA), and\n        - official EU acceding and candidate countries.\n        Examples are data on the United States of America, Japan or China. Often, such data are included in Eurostat data tables. In such cases, a re-user would need to eliminate such data from the tables before reusing them commercially.\n\td. Trade data originating from Liechtenstein and Switzerland (as declaring countries), from 1995 onwards, and concerning the following commodity classifications: HS, SITC, BEC, NSTR and national commodity classifications. Thus it is, for example, not allowed to sell export/import data declared by Switzerland (concerning the above named commodity classifications). However, it is allowed to sell Swiss export/import data declared by an EU Member State (but see below a similar exception for Austria).\n\te. Trade data originating from Austria (as a declaring country) for a level of detail of the Combined Nomenclature of 8 digits; again, it is not allowed to sell export/import declared by Austria (concerning the above named commodity classifications), but it is allowed to sell Austrian export/import data declared by another EU Member State.\n\n# What to do if you want to re-use Eurostat material for commercial purposes\n\nThere is no special procedure or requirement for a written licence. Just download the material and use it (unless the material is listed in the exceptions above).\n\n# Legal notice of the European Commission\n\nThe basis for the copyright and licence policy of Eurostat is the legal notice of the European Commission 'Europa website' which can be found here: https://ec.europa.eu/info/legal-notice_en\n\n# Political context\n\nThis approach implements the policy of the European Statistical System (ESS), adopted in February 2013, under which the ESS has committed itself to provide its statistics free of charge as a public good of high quality, irrespective of subsequent commercial or non-commercial use.\n(see https://ec.europa.eu/eurostat/web/european-statistical-system/programmes-and-activities/reuse-ess-statistics)\n\n# Contact\n\nAny question regarding the copyright or re-use of Eurostat data or texts may be sought from the Publications Office of the European Union at the following address:\n\nPublications Office,\nCopyright and Legal Issues\n2, rue Mercier, 2985 Luxembourg\ne-mail: op-copyright@publications.europa.eu\n",
            "url_summary": "https://ec.europa.eu/eurostat/web/main/about-us/policies/copyright",
            "url_legal": "https://ec.europa.eu/eurostat/web/main/about-us/policies/copyright",
            "image_url": "/storage/"
        },
        "contacts": [],
        "entities": [
            {
                "uid": "euph"
            }
        ],
        "contributors": [],
        "parts": [
            {
                "uid": "NUTSA3.RNITS37.0",
                "name": "Area units",
                "description": "This table contains the designation of NUTS level 1, 2, 3 and LAU used in the respective EU Member States and additional non-EU countries in local script and transcribed into Latin script if a script other than Latin has been used.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NTSBR38.0",
                "name": "NUTS border",
                "description": "This table contains the classification of NUTS level 3 regions according to the existence of land borders.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NTSCS39.0",
                "name": "NUTS coastal",
                "description": "This table contains the classification of NUTS level 3 regions according to the existence of a coastline.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NTSMN40.0",
                "name": "NUTS mountain",
                "description": "This table contains the classification of NUTS level 3 regions according to the existence of mountain areas.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRM41.0",
                "name": "NUTS remoteness",
                "description": "This table contains the classification of NUTS level 3 regions according to urban-rural remoteness.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRB42.0",
                "name": "NUTS urban rural",
                "description": "This table contains the classification of NUTS level 3 regions according to urban or rural character. ",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.0",
                "name": "NUTS    ",
                "description": "This table contains NUTS version 2021 codes from EU Member States and additional non-EU countries (NUTS level 0, 1, 2 and 3). ",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.LAUAB44.0",
                "name": "LAU      ",
                "description": "This table contains local administrative units (LAU) of EU Member States and additional non-EU countries.",
                "created_at": "2023-09-01T08:53:40.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            },
            {
                "uid": "NUTSA3.PSTCD71.0",
                "name": "Postcode",
                "description": "This table contains postcodes and the corresponding NUTS level 3 region from EU Member States and non-EU countries. ",
                "created_at": "2023-10-02T15:42:03.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            }
        ],
        "descriptors": [
            {
                "uid": "NUTSA3.RNITS37.NTSLV37",
                "namespace": null,
                "name": "NutsLevel1",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSLV38",
                "namespace": null,
                "name": "NutsLevel1Latin",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSLV39",
                "namespace": null,
                "name": "NutsLevel2",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSLV40",
                "namespace": null,
                "name": "NutsLevel2Latin",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSLV41",
                "namespace": null,
                "name": "NutsLevel3",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSLV42",
                "namespace": null,
                "name": "NutsLevel3Latin",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.CLUMN43",
                "namespace": null,
                "name": "column1",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.CLUMN44",
                "namespace": null,
                "name": "column1",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSBR38.DNTFR45",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSBR38.DSCRP46",
                "namespace": null,
                "name": "description",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSCS39.DNTFR47",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSCS39.DSCRP48",
                "namespace": null,
                "name": "description",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSMN40.DNTFR49",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSMN40.DSCRP50",
                "namespace": null,
                "name": "description",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRM41.DNTFR51",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRM41.DSCRP52",
                "namespace": null,
                "name": "description",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRB42.DNTFR53",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NTSRB42.DSCRP54",
                "namespace": null,
                "name": "description",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.NAMEA56",
                "namespace": null,
                "name": "name",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.NMNLT57",
                "namespace": null,
                "name": "nameInLatin",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.LEVEL58",
                "namespace": null,
                "name": "level",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.VRSNA59",
                "namespace": null,
                "name": "version",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.SMTRP61",
                "namespace": null,
                "name": "isMetropolitan",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.MTRPL62",
                "namespace": null,
                "name": "metropolitanCode",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.MTRPL63",
                "namespace": null,
                "name": "metropolitanLabel",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.SSLND67",
                "namespace": null,
                "name": "isIsland",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.VLDFR69",
                "namespace": null,
                "name": "validFrom",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.NUTSA43.VLDTO70",
                "namespace": null,
                "name": "validTo",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.LAUAB44.DNTFR71",
                "namespace": null,
                "name": "identifier",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.LAUAB44.NAMEA74",
                "namespace": null,
                "name": "name",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.LAUAB44.NMNLT75",
                "namespace": null,
                "name": "nameInLatin",
                "description": null,
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-20T16:14:20.000000Z"
            },
            {
                "uid": "NUTSA3.RNITS37.NTSCD438",
                "namespace": null,
                "name": "nuts2021:codeParent",
                "description": "The NUTS code of a region of which the given NUTS code is part of.",
                "notes": null,
                "examples": null,
                "class": null,
                "unit": null,
                "deprecated": false,
                "created_at": "2024-04-08T10:32:22.000000Z",
                "updated_at": "2025-01-19T09:40:27.000000Z"
            },
            {
                "uid": "0.0.LPHCN4",
                "namespace": "iso-3166",
                "name": "alpha-2CountryCode",
                "description": "A two-letter code that represents a country name, recommended as the general purpose code in ISO 3166-1 (Codes for the representation of names of countries and their subdivisions Part 1: Country code) and ISO 3166-3 (Codes for the representation of names of countries and their subdivisions Part 3: Code for formerly used names of countries).",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 7294]",
                "unit": null,
                "deprecated": false,
                "created_at": "2022-11-19T09:03:29.000000Z",
                "updated_at": "2025-01-20T16:18:19.000000Z"
            },
            {
                "uid": "0.0.NTSCD55",
                "namespace": "eurostat",
                "name": "nutsCode",
                "description": "A 3 to 5 digit code with the following structure: It begins with a two-letter code referencing the country, which is not necessarily identical with the alpha-2 code in ISO 3166-1. Each of three possible subdivision of the country are then referred to with one additional number from 1 to 9, or a latin capital letter where a subdivision has more than nine entities.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 3328]",
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-26T19:54:06.000000Z"
            },
            {
                "uid": "0.0.LCODE73",
                "namespace": "eurostat",
                "name": "lauCode",
                "description": "> To meet the demand for statistics at a local level, Eurostat maintains a system of local administrative units (LAUs) compatible with NUTS. These LAUs are the building blocks of the NUTS, and comprise the municipalities and communes of the European Union. [...]\n> \n> The LAUs are:\n> \n> administrative for reasons such as the availability of data and policy implementation capacity\n> a subdivision of the NUTS 3 regions covering the whole economic territory of the Member States\n> appropriate for the implementation of local level typologies included in Tercet, namely the coastal area and DEGURBA classification.\n> Since there are frequent changes to the LAUs, Eurostat publishes an updated list towards the end of each year.\n> \n> The NUTS regulation makes provision for EU Member States to send the lists of their LAUs to Eurostat. If available, Eurostat receives additionally basic administrative data by means of the annual LAU lists, namely total population and total area for each LAU.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 7274]",
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-01-26T19:54:20.000000Z"
            },
            {
                "uid": "0.0.TEXTA315",
                "namespace": null,
                "name": "Text",
                "description": "In computer programming, a string is traditionally a sequence of characters, either as a literal constant or as some kind of variable. The latter may allow its elements to be mutated and the length changed, or it may be fixed (after creation). A string is generally considered as a data type and is often implemented as an array data structure of bytes (or words) that stores a sequence of elements, typically characters, using some character encoding. String may also denote more general arrays or other sequence (or list) data types and structures.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 7322]",
                "unit": null,
                "deprecated": false,
                "created_at": null,
                "updated_at": "2024-09-14T11:17:02.000000Z"
            },
            {
                "uid": "0.0.RCRDD344",
                "namespace": "beexml",
                "name": "recordID",
                "description": "Unique sequence of integers associated with a record within a certain table.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 3331]",
                "unit": null,
                "deprecated": false,
                "created_at": "2023-11-26T12:08:55.000000Z",
                "updated_at": "2025-01-20T16:14:21.000000Z"
            },
            {
                "uid": "0.0.PSTCD378",
                "namespace": "eurostat",
                "name": "postcode",
                "description": "> A postal code (also known locally in various English-speaking countries throughout the world as a postcode, post code, PIN or ZIP Code) is a series of letters or digits or both, sometimes including spaces or punctuation, included in a postal address for the purpose of sorting mail. ",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 3343]",
                "unit": null,
                "deprecated": false,
                "created_at": "2023-12-05T14:50:27.000000Z",
                "updated_at": "2025-01-26T19:55:12.000000Z"
            }
        ],
        "published_at": "2023-04-01T22:00:00.000000Z",
        "id": 3,
        "created_at": "2023-01-26T18:18:06.000000Z",
        "updated_at": "2025-01-16T14:38:36.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Response

Response Fields

data object[]

A list of Datasets available to the User.example email address, url or other.

uid string

The unique identifier used to identify the entity within the platform.

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

description string

Longer description about the dataset. Uses Markdown for styling.

status string

The status of the dataset. The list of available status are the following: draft, pending, reject, reviewing, pending-peer-rev, peer-reviewing, publish, publish-with-pw, trash, hidden

public boolean

1 means that the data of this dataset are public.

licence

array|null The licence information of this entity.

name string

The name of the licence.

abbreviation string

The short name of the licence.

description string

The description of the licence.

uid string

The unique identifier of the licence.

url_summary string|null

Url to external description of this licence.

url_legal string|null

Url to external legal definition of this licence.

image_url string|null

Url to licence image representation.

contact object[]

A list of contact points for the entity.

type string

The type of the contact.

value string

The actual value of the contact, for

entities string[]

Array containing the uid of the entities of this dataset.

* string

The Uid of the entity.

contributors string[]

Array containing the uid of the contributors of this dataset.

* string

The Uid of the contributor.

parts string[]

An array containing all related dataset tables. Field ss hidden for non-public datasets.

* object

uid string

The unique identifier used to identify the table within the platform.

name string

Name of the table.

description string

Description of the table. Uses Markdown for styling.

created_at string

The date and time the table was created.

updated_at string

The date and time the table was last updated.

descriptors string[]

An array of all descriptors, used to integrate this dataset. Field ss hidden for non-public datasets.

* object

uid string

The unique identifier used to identify the descriptor within the platform.

namespace string|null

The namespace this descriptor belongs to.

name string

Name of the descriptor.

description string|null

A short, concise description of the descriptor. If a class is assigned to descriptor, this field contains the accepted definition of the related class. Uses Markdown for styling.

notes string|null

Any additional notes attached to the descriptor. Uses Markdown for styling.

examples string|null

A list of examples, how the data may appear. Uses Markdown for styling.

class string|null

An optional class, related to this descriptor.

unit string|null

The unit data is saved in. May not be set.

deprecated boolean

Whether this descriptor is deprecated or not. Deprecated descriptors can not be used to import new data.

created_at string

The date and time the table was created.

updated_at string

The date and time the table was last updated.

published_at string|null

The date and time the dataset was published.

created_at string

The date and time the dataset was created.

updated_at string

The date and time the dataset was last updated.

List data

requires authentication

Retrieves data based on dataset table unique identifier.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/discovery/data/NUTSA3.RNITS37.0?limit=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/discovery/data/NUTSA3.RNITS37.0';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'limit' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/discovery/data/NUTSA3.RNITS37.0"
);

const params = {
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/discovery/data/NUTSA3.RNITS37.0'
params = {
  'limit': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "id": 5144238,
            "timestamp": null,
            "data": [
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "alpha2code",
                    "value": "AL",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV41",
                    "column": "nuts3",
                    "value": "Qarks",
                    "unit": null
                }
            ]
        },
        {
            "id": 5144239,
            "timestamp": null,
            "data": [
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "alpha2code",
                    "value": "AT",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV37",
                    "column": "nuts1",
                    "value": "Gruppen von \nBundesländern",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV39",
                    "column": "nuts2",
                    "value": "Bundesländer",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV41",
                    "column": "nuts3",
                    "value": "Gruppen von Gemeinden",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "lau",
                    "value": "Gemeinden",
                    "unit": null
                }
            ]
        },
        {
            "id": 5144240,
            "timestamp": null,
            "data": [
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "alpha2code",
                    "value": "BE",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV37",
                    "column": "nuts1",
                    "value": "Gewesten / \nRégions",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV39",
                    "column": "nuts2",
                    "value": "Provincies / Provinces",
                    "unit": null
                },
                {
                    "descriptor": "NUTSA3.RNITS37.NTSLV41",
                    "column": "nuts3",
                    "value": "Arrondisse-menten / Arrondisse-ments",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "lau",
                    "value": "Gemeenten / Communes",
                    "unit": null
                }
            ]
        }
    ],
    "first_page_url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=1",
    "from": 1,
    "last_page": 13,
    "last_page_url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=13",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=8",
            "label": "8",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=9",
            "label": "9",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=10",
            "label": "10",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=11",
            "label": "11",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=12",
            "label": "12",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=13",
            "label": "13",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0?page=2",
    "path": "https://pollinatorhub/api/v1/discovery/data/NUTSA3.RNITS37.0",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 37
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/discovery/data/{dataset_part_uid}

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

dataset_part_uid string optional

The unique identifier from a dataset table. Example: NUTSA3.RNITS37.0

Query Parameters

page integer optional

Load specified page to view the results. Default: 1

limit integer optional

Set the amount of results the API returns. Up to 1000. Default: 100 Example: 3

Response

Response Fields

records object[]

List of Records.

* object

id string

The record id, used to identify it in EUPH database.

timestamp string

Timestamp this record was recorded at.

data object[]

List of data contained within the Record.

* object

column string

The name of the column, the value was imported from.

descriptor string

The UID of the descriptor this datum represents.

value

The value of the datum.

unit string|null

The UID of the Unit, this datum is related to. Can be null.

Entities

A group of routes used to manage Entities (Data providers), related to authenticated user.

List Entities

requires authentication

Retrieve a list of all entities authenticated user has access to.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/entities?page=1&limit=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'page' => '1',
            'limit' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/entities"
);

const params = {
    "page": "1",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/entities'
params = {
  'page': '1',
  'limit': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "uid": "boe",
            "name": "Biene Österreich – Imkereidachverband",
            "contact": [
                {
                    "type": "address",
                    "value": "Georg-Coch Platz 3/11a, 1010 Wien"
                },
                {
                    "type": "url",
                    "value": "https://www.biene-oesterreich.at/"
                },
                {
                    "type": "email",
                    "value": "office@biene-oesterreich.at"
                }
            ],
            "abbreviation": " BÖ",
            "registry_number": null,
            "description": "The Austrian Beekeepers Federation ([BÖ](https://www.biene-oesterreich.at/), *Biene Österreich-Imkereidachverband*) is the umbrella organisation of the two largest beekeeping associations in Austria, the Austrian Beekepers Association ([ÖIB](https://www.imkerbund.at/), *Österreichischer Imkerbund*) and the Austrian Professional Beekeepers Association ([ÖEIB](https://www.erwerbsimkerbund.at/), *Österreichischer Erwerbsimkerbund*). ",
            "address": "Georg-Coch Platz3/11a, 1010 Wien, Austria",
            "country": {
                "iso-3166-country-name": "the Republic of Austria",
                "iso-3166-numeric-country-code": "40",
                "iso-3166-country-name-short-lc": "Austria",
                "iso-3166-alpha-2-country": "AT",
                "iso-3166-alpha-3-country": "AUT"
            },
            "user_id": 3,
            "id": 13,
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2023-11-21T13:58:41.000000Z"
        },
        {
            "uid": "euph",
            "name": "EU Pollinator Hub",
            "contact": [
                {
                    "type": "url-linkedin",
                    "value": "https://www.linkedin.com/company/beelife-european-beekeeping-coordination/"
                },
                {
                    "type": "url",
                    "value": "https://pollinatorhub.eu"
                }
            ],
            "abbreviation": "EUPH",
            "registry_number": null,
            "description": "The EU Pollinator Hub (EUPH) is a data hub related to pollinators, which is provided by the European Food Safety Authority (EFSA).",
            "address": null,
            "country": {
                "iso-3166-country-name": "the Kingdom of Belgium",
                "iso-3166-numeric-country-code": "56",
                "iso-3166-country-name-short-lc": "Belgium",
                "iso-3166-alpha-2-country": "BE",
                "iso-3166-alpha-3-country": "BEL"
            },
            "user_id": 3,
            "id": 3,
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2024-06-04T12:59:02.000000Z"
        },
        {
            "uid": "efsa",
            "name": "European Food Safety Authority",
            "contact": [],
            "abbreviation": "EFSA",
            "registry_number": null,
            "description": "The European Food Safety Authority (EFSA) is an agency of the European Union (EU) that provides independent scientific advice to policy makers and carries out risk assessment functions. It covers the following topics: animal health and welfare, antimicrobial resistance, chemical contaminants in food and feed, foodborne zoonotic diseases, nutrition, pesticides and qualified presumption of safety.",
            "address": null,
            "country": {
                "iso-3166-country-name": "the Republic of Italy",
                "iso-3166-numeric-country-code": "380",
                "iso-3166-country-name-short-lc": "Italy",
                "iso-3166-alpha-2-country": "IT",
                "iso-3166-alpha-3-country": "ITA"
            },
            "user_id": 3,
            "id": 14,
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2023-10-26T17:37:58.000000Z"
        }
    ],
    "first_page_url": "https://pollinatorhub/api/v1/entities?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "https://pollinatorhub/api/v1/entities?page=2",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/entities?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://pollinatorhub/api/v1/entities?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/entities?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://pollinatorhub/api/v1/entities?page=2",
    "path": "https://pollinatorhub/api/v1/entities",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 4
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/entities

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

Query Parameters

page integer optional

Load specified page to view the results. Default: 1 Example: 1

limit integer optional

Set the amount of results the API returns. Up to 1000. Default: 100 Example: 3

Response

Response Fields

data string[]

A list of entities available to the User.

* object

uid string

The unique identifier used to identify the entity within the platform.

name string

A descriptive name of the entity.

slug string

The URL used to access the entity

contact object[]

A list of contact points for the entity.

type string

The type of the contact.

value string

The actual value of the contact, for example email address, url or other.

abbreviation string

Abbreviation or short name of the entity.

registry_number string

A public unique identifier used to identify a legal entity. Can be empty for private persons.

description string

A longer description about the entity. Uses Markdown for styling.

address string

Full address of the entity. Can be empty for private persons.

country object

Country the entity resides in.

iso-3166-country-name string

Full name of the country.

iso-3166-country-name-short-lc string

Short name, written in lower case letters, of the country.

iso-3166-numeric-country-code string

Numeric code of the country according to ISO-3166 standard.

iso-3166-alpha-2-country string

A two-letter code that represents a country name, recommended as general purpose code.

iso-3166-alpha-3-country string

A three-letter code that represents a country name.

user_id integer

Numeric identifier of a user.

type string

Type of the Entity.

personal_team boolean

This Entity represents the User.

created_at string

The date and time the entity was created.

updated_at string

The date and time the entity was last updated.

POST api/v1/entities

requires authentication

Example request:

curl --request POST \
    "https://app.pollinatorhub.eu/api/v1/entities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"European Food Safety Authority\",
    \"abbreviation\": \"EFSA\",
    \"description\": \"No-example\",
    \"country_id\": \"IT\",
    \"type\": \"legal-entity\",
    \"contact\": [
        {
            \"type\": \"email\",
            \"value\": \"example@pollinatorhub.eu\"
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'European Food Safety Authority',
            'abbreviation' => 'EFSA',
            'description' => 'No-example',
            'country_id' => 'IT',
            'type' => 'legal-entity',
            'contact' => [
                [
                    'type' => 'email',
                    'value' => 'example@pollinatorhub.eu',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/entities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "European Food Safety Authority",
    "abbreviation": "EFSA",
    "description": "No-example",
    "country_id": "IT",
    "type": "legal-entity",
    "contact": [
        {
            "type": "email",
            "value": "example@pollinatorhub.eu"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/entities'
payload = {
    "name": "European Food Safety Authority",
    "abbreviation": "EFSA",
    "description": "No-example",
    "country_id": "IT",
    "type": "legal-entity",
    "contact": [
        {
            "type": "email",
            "value": "example@pollinatorhub.eu"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/entities

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

A descriptive name of the entity. Must not be greater than 250 characters. Must be at least 8 characters. Example: European Food Safety Authority

abbreviation string

Abbreviation or short name of the entity. Must not be greater than 50 characters. Must be at least 3 characters. Example: EFSA

address string optional

Full address of the entity. It is not required for private persons. This field is required unless registry_number is in null. Must not be greater than 15000000 characters. Must be at least 10 characters.

registry_number string optional

A public unique identifier used to identify a legal entity. Can be empty for private persons. Must not be greater than 20 characters. Must be at least 5 characters.

description string

A longer description about the entity. Accepts Markdown for styling. Must not be greater than 16777215 characters. Must be at least 10 characters. Example: No-example

country_id string

A two-letter code that represents a country name, recommended as general purpose code. Must be 2 characters. Example: IT

Must be one of:

AQ
BG
BI
KH
DZ
CM
CA
CV
KY
CF
LK
TD
CL
CN
TW
AS
CX
CC
CO
KM
YT
CG
CK
CR
HR
CU
CY
AD
CZ
BJ
DK
DM
DO
EC
SV
GQ
ET
ER
EE
FO
FK
GS
AO
FJ
FI
AX
FR
GF
PF
TF
DJ
GA
GE
GM
PS
DE
AG
GH
GI
KI
GR
GL
GD
AZ
GP
GU
AR
GT
GN
GY
HT
HM
VA
HN
HK
HU
IS
IN
AU
ID
IR
IQ
IE
IL
IT
CI
JM
JP
KZ
AF
AT
JO
KE
KP
KR
KW
KG
LA
LB
LS
LV
LR
LY
LI
BS
LT
LU
MO
MG
MW
MY
MV
ML
MT
MQ
MR
BH
MU
MX
MC
MN
MD
ME
BD
MS
MA
MZ
AM
OM
NA
BB
NR
NP
NL
CW
AW
SX
BQ
VU
NZ
NI
BE
NE
NG
NU
NF
NO
MP
UM
FM
MH
PW
PK
PA
PG
BM
PY
PE
PH
PN
PL
PT
GW
PR
QA
RE
BT
RO
RU
RW
BL
SH
KN
AI
LC
MF
PM
VC
SM
ST
BO
SA
SN
RS
SC
SL
BA
SG
SK
VN
SI
SO
ZA
ZW
BW
ES
SS
SD
EH
BV
SR
SJ
SZ
SE
CH
BR
SY
TJ
TH
TG
TK
TO
TT
AE
TN
TR
TM
TC
TV
AL
UG
UA
MK
EG
GB
GG
JE
IM
TZ
BZ
US
VI
UY
IO
UZ
VE
WF
WS
YE
ZM
SB
VG
BN
BY
CT
CS
NQ
DD
JT
MI
PC
PU
BF
WK
YD
AN
MM
NT
TL
CS
CD
CQ
FX
SU

contact object[] optional

A list of contact points for the entity.

type string

The type of the contact. Should be one of: email, url, phone, address, url-facebook, url-twitter, url-linkedin, url-youtube, url-vimeo. Example: email

value string

The actual value of the contact, for example email address, url or other. Example: example@pollinatorhub.eu

type string

Example: legal-entity

Must be one of:

person
legal-entity

Show Entity

requires authentication

Displays a single entity based on unique identifier. Only allows viewing entities that the user has access to.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/entities/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/entities/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/entities/3'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
access-control-allow-origin: *


{
    "data": {
        "uid": "euph",
        "name": "EU Pollinator Hub",
        "contact": [
            {
                "type": "url-linkedin",
                "value": "https://www.linkedin.com/company/beelife-european-beekeeping-coordination/"
            },
            {
                "type": "url",
                "value": "https://pollinatorhub.eu"
            }
        ],
        "abbreviation": "EUPH",
        "registry_number": null,
        "description": "The EU Pollinator Hub (EUPH) is a data hub related to pollinators, which is provided by the European Food Safety Authority (EFSA).",
        "address": null,
        "country": {
            "iso-3166-country-name": "the Kingdom of Belgium",
            "iso-3166-numeric-country-code": "56",
            "iso-3166-country-name-short-lc": "Belgium",
            "iso-3166-alpha-2-country": "BE",
            "iso-3166-alpha-3-country": "BEL"
        },
        "user_id": 3,
        "id": 3,
        "created_at": "2023-10-05T10:02:30.000000Z",
        "updated_at": "2024-06-04T12:59:02.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Response

Response Fields

data object

name string

A descriptive name of the entity.

slug string

The URL used to access the entity

uid string

The unique identifier used to identify the Entity within the platform.

contact object[]

A list of contact points for the entity.

type string

The type of the contact.

value string

The actual value of the contact, for example email address, url or other.

abbreviation string

Abbreviation or short name of the entity.

registry_number string

A public unique identifier used to identify a legal entity. Can be empty for private persons.

description string

A longer description about the entity. Uses Markdown for styling.

address string

Full address of the entity. Can be empty for private persons.

country object

Country the entity resides in.

iso-3166-country-name string

Full name of the country.

iso-3166-country-name-short-lc string

Short name, written in lower case letters, of the country.

iso-3166-numeric-country-code string

Numeric code of the country according to ISO-3166 standard.

iso-3166-alpha-2-country string

A two-letter code that represents a country name, recommended as general purpose code.

iso-3166-alpha-3-country string

A three-letter code that represents a country name.

user_id integer

Numeric identifier of a user.

type string

Type of the Entity.

personal_team boolean

This Entity represents the User.

created_at string

The date and time the entity was created.

updated_at string

The date and time the entity was last updated.

PUT api/v1/entities/{id}

requires authentication

Example request:

curl --request PUT \
    "https://app.pollinatorhub.eu/api/v1/entities/nulla" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"European Food Safety Authority\",
    \"abbreviation\": \"EFSA\",
    \"description\": \"No-example\",
    \"country_id\": \"IT\",
    \"contact\": [
        {
            \"type\": \"email\",
            \"value\": \"example@pollinatorhub.eu\"
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities/nulla';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'European Food Safety Authority',
            'abbreviation' => 'EFSA',
            'description' => 'No-example',
            'country_id' => 'IT',
            'contact' => [
                [
                    'type' => 'email',
                    'value' => 'example@pollinatorhub.eu',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/entities/nulla"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "European Food Safety Authority",
    "abbreviation": "EFSA",
    "description": "No-example",
    "country_id": "IT",
    "contact": [
        {
            "type": "email",
            "value": "example@pollinatorhub.eu"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/entities/nulla'
payload = {
    "name": "European Food Safety Authority",
    "abbreviation": "EFSA",
    "description": "No-example",
    "country_id": "IT",
    "contact": [
        {
            "type": "email",
            "value": "example@pollinatorhub.eu"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/entities/{id}

PATCH api/v1/entities/{id}

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

The ID of the entity. Example: nulla

Body Parameters

name string

A descriptive name of the entity. Must not be greater than 250 characters. Must be at least 8 characters. Example: European Food Safety Authority

abbreviation string

Abbreviation or short name of the entity. Must not be greater than 50 characters. Must be at least 3 characters. Example: EFSA

address string optional

Full address of the entity. It is not required for private persons. This field is required unless registry_number is in null. Must not be greater than 16777215 characters. Must be at least 10 characters.

registry_number string optional

A public unique identifier used to identify a legal entity. Can be empty for private persons. Must not be greater than 20 characters. Must be at least 5 characters.

description string

A longer description about the entity. Accepts Markdown for styling. Must not be greater than 15000000 characters. Must be at least 10 characters. Example: No-example

country_id string

A two-letter code that represents a country name, recommended as general purpose code. Must be 2 characters. Example: IT

Must be one of:

AQ
BG
BI
KH
DZ
CM
CA
CV
KY
CF
LK
TD
CL
CN
TW
AS
CX
CC
CO
KM
YT
CG
CK
CR
HR
CU
CY
AD
CZ
BJ
DK
DM
DO
EC
SV
GQ
ET
ER
EE
FO
FK
GS
AO
FJ
FI
AX
FR
GF
PF
TF
DJ
GA
GE
GM
PS
DE
AG
GH
GI
KI
GR
GL
GD
AZ
GP
GU
AR
GT
GN
GY
HT
HM
VA
HN
HK
HU
IS
IN
AU
ID
IR
IQ
IE
IL
IT
CI
JM
JP
KZ
AF
AT
JO
KE
KP
KR
KW
KG
LA
LB
LS
LV
LR
LY
LI
BS
LT
LU
MO
MG
MW
MY
MV
ML
MT
MQ
MR
BH
MU
MX
MC
MN
MD
ME
BD
MS
MA
MZ
AM
OM
NA
BB
NR
NP
NL
CW
AW
SX
BQ
VU
NZ
NI
BE
NE
NG
NU
NF
NO
MP
UM
FM
MH
PW
PK
PA
PG
BM
PY
PE
PH
PN
PL
PT
GW
PR
QA
RE
BT
RO
RU
RW
BL
SH
KN
AI
LC
MF
PM
VC
SM
ST
BO
SA
SN
RS
SC
SL
BA
SG
SK
VN
SI
SO
ZA
ZW
BW
ES
SS
SD
EH
BV
SR
SJ
SZ
SE
CH
BR
SY
TJ
TH
TG
TK
TO
TT
AE
TN
TR
TM
TC
TV
AL
UG
UA
MK
EG
GB
GG
JE
IM
TZ
BZ
US
VI
UY
IO
UZ
VE
WF
WS
YE
ZM
SB
VG
BN
BY
CT
CS
NQ
DD
JT
MI
PC
PU
BF
WK
YD
AN
MM
NT
TL
CS
CD
CQ
FX
SU

contact object[] optional

A list of contact points for the entity.

type string

The type of the contact. Should be one of: email, url, phone, address, url-facebook, url-twitter, url-linkedin, url-youtube, url-vimeo. Example: email

value string

The actual value of the contact, for example email address, url or other. Example: example@pollinatorhub.eu

DELETE api/v1/entities/{id}

requires authentication

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/entities/impedit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities/impedit';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/entities/impedit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/entities/impedit'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Datasets

This route will allow modifications to the meta-data for the Datasets. It includes basic information like name, description and contact information. It is owned by one or more entities. It directly owns one or more Dataset Parts. It is identified by UID which is created during the data entity creation procedure.

List datasets

requires authentication

Display a listing of the Datasets, the User has access to.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/datasets?entity=euph&page=1&limit=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'entity' => 'euph',
            'page' => '1',
            'limit' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets"
);

const params = {
    "entity": "euph",
    "page": "1",
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets'
params = {
  'entity': 'euph',
  'page': '1',
  'limit': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "uid": "HNYPR6.0.0",
            "name": "Honey production Austria",
            "longName": "Honey production in Austria",
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-04-16T22:00:00.000000Z",
            "id": 6,
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2024-01-25T09:26:57.000000Z"
        },
        {
            "uid": "BKPNG8.0.0",
            "name": "Beekeeping Austria",
            "longName": "Collection of data related to honey bees in Austria.",
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-11-30T23:00:00.000000Z",
            "id": 8,
            "created_at": "2022-04-27T07:15:00.000000Z",
            "updated_at": "2024-01-25T09:26:57.000000Z"
        },
        {
            "uid": "VTCSS14.0.0",
            "name": "Vetcases",
            "longName": "Reports of notifiable diseases reported for Apis mellifera",
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-06-12T22:00:00.000000Z",
            "id": 14,
            "created_at": "2023-02-08T15:11:52.000000Z",
            "updated_at": "2025-01-22T14:03:01.000000Z"
        }
    ],
    "first_page_url": "https://pollinatorhub/api/v1/datasets?page=1",
    "from": 1,
    "last_page": 13,
    "last_page_url": "https://pollinatorhub/api/v1/datasets?page=13",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=8",
            "label": "8",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=9",
            "label": "9",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=10",
            "label": "10",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=11",
            "label": "11",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=12",
            "label": "12",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=13",
            "label": "13",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/datasets?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://pollinatorhub/api/v1/datasets?page=2",
    "path": "https://pollinatorhub/api/v1/datasets",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 39
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/datasets

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

Query Parameters

entity string optional

Filter datasets by Entity uid. Example: euph

page integer optional

Load specified page to view the results. Default: 1 Example: 1

limit integer optional

Set the amount of results the API returns. Up to 1000. Default: 100 Example: 3

Response

Response Fields

data object[]

A list of Datasets available to the User.example email address, url or other.

* object

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

number string

Number to identify the dataset. The number will be automatically generated when the dataset is created.

slug string

The URL used to access the entity

uid string

The unique identifier used to identify the entity within the platform.

description string

Longer description about the dataset. Uses Markdown for styling.

entities string[]

Array containing the uid of the entities of this dataset.

* string

The Uid of the entity

contact object[]

A list of contact points for the entity.

type string

The type of the contact.

value string

The actual value of the contact, for

status string

The status of the dataset. The list of available status are the following: draft, pending, reject, reviewing, pending-peer-rev, peer-reviewing, publish, publish-with-pw, trash, hidden

public boolean

1 means that the data of this dataset are public.

licence string|null

The uid of the licence of this entity.

published_at string|null

The date and time the dataset was published.

created_at string

The date and time the dataset was created.

updated_at string

The date and time the dataset was last updated. /

Create dataset

requires authentication

Example request:

curl --request POST \
    "https://app.pollinatorhub.eu/api/v1/datasets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ISO 3166-1:2020\",
    \"long_name\": \"zbtmogtoqtepvozcogxkqqvjgcqmysbpqqxdcmioirgvgivpsuekefex\",
    \"description\": \"Consequatur omnis sequi impedit deleniti odio fugiat sit quis.\",
    \"status\": \"pending\",
    \"licence\": \"cc-by\",
    \"entities\": [
        \"euph\"
    ],
    \"published_at\": \"2023-07-04T11:24:58.000000Z\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ISO 3166-1:2020',
            'long_name' => 'zbtmogtoqtepvozcogxkqqvjgcqmysbpqqxdcmioirgvgivpsuekefex',
            'description' => 'Consequatur omnis sequi impedit deleniti odio fugiat sit quis.',
            'status' => 'pending',
            'licence' => 'cc-by',
            'entities' => [
                'euph',
            ],
            'published_at' => '2023-07-04T11:24:58.000000Z',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ISO 3166-1:2020",
    "long_name": "zbtmogtoqtepvozcogxkqqvjgcqmysbpqqxdcmioirgvgivpsuekefex",
    "description": "Consequatur omnis sequi impedit deleniti odio fugiat sit quis.",
    "status": "pending",
    "licence": "cc-by",
    "entities": [
        "euph"
    ],
    "published_at": "2023-07-04T11:24:58.000000Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets'
payload = {
    "name": "ISO 3166-1:2020",
    "long_name": "zbtmogtoqtepvozcogxkqqvjgcqmysbpqqxdcmioirgvgivpsuekefex",
    "description": "Consequatur omnis sequi impedit deleniti odio fugiat sit quis.",
    "status": "pending",
    "licence": "cc-by",
    "entities": [
        "euph"
    ],
    "published_at": "2023-07-04T11:24:58.000000Z"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/datasets

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

The name of the Dataset Part. Must not be greater than 100 characters. Must be at least 3 characters. Example: ISO 3166-1:2020

long_name string

The long version of the name of the dataset. Must not be greater than 256 characters. Must be at least 8 characters. Example: zbtmogtoqtepvozcogxkqqvjgcqmysbpqqxdcmioirgvgivpsuekefex

description string

A longer description about the Dataset Part. Accepts Markdown for styling. Must not be greater than 15000000 characters. Must be at least 10 characters. Example: Consequatur omnis sequi impedit deleniti odio fugiat sit quis.

status string

The status of the dataset. Example: pending

Must be one of:

draft
pending

licence string

The UID of the licence of this entity. Example: cc-by

Must be one of:

cc-by-4-0
cc-by-sa-4-0
cc-by-nd-4-0
cc-by-nc-4-0
cc-by-nc-sa-4-0
cc-by-nc-nd-4-0
cc0-1-0
eurostat
cc-by-nc-sa-3.0-igo
statcube
table-specific-licence

entities string[]

The UID of of an related Entity. The uid of an existing record in the user_entities table.

published_at string

The date this Dataset Part can be published on the platform. A null value is allowed, having no or unknown publishing date. Must be a valid date. Example: 2023-07-04T11:24:58.000000Z

Show dataset

requires authentication

Display the specified Dataset based on provided unique identifier.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/datasets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
access-control-allow-origin: *


{
    "data": {
        "uid": "EUPHA1.0.0",
        "name": "EUPH",
        "long_name": null,
        "description": "This dataset contains the basic data created for the platform to function.",
        "status": "hidden",
        "public": false,
        "licence": {
            "uid": "euph",
            "name": "EU Pollinator Hub",
            "abbreviation": "EUPH",
            "description": "For internal use by the EU Pollinator Hub (EUPH) only.",
            "url_summary": null,
            "url_legal": null,
            "image_url": "/storage/"
        },
        "contacts": [],
        "entities": [
            3
        ],
        "contributors": [],
        "published_at": null,
        "id": 1,
        "created_at": "2023-09-01T08:53:36.000000Z",
        "updated_at": "2024-04-05T17:46:43.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/datasets/{id}

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the dataset. Example: 1

uid string

The unique identifier used to identify the Dataset within the platform. Example: countries

Response

Response Fields

data object

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

number string

Number to identify the dataset. The number will be automatically generated when the dataset is created.

slug string

The URL used to access the entity

uid string

The unique identifier used to identify the entity within the platform.

description string

Longer description about the dataset. Uses Markdown for styling.

entities string[]

Array containing the uid of the entities of this dataset.

* string

The Uid of the entity

contact object[]

A list of contact points for the entity.

type string

The type of the contact.

value string

The actual value of the contact, for example email address, url or other.

status string

The status of the dataset. The list of available status are the following: draft, pending, reject, reviewing, pending-peer-rev, peer-reviewing, publish, publish-with-pw, trash, hidden

public boolean

1 means that the data of this dataset are public.

licence string|null

The uid of the licence of this entity.

published_at string|null

The date and time the dataset was published.

created_at string

The date and time the dataset was created.

updated_at string

The date and time the dataset was last updated.

Update dataset

requires authentication

Example request:

curl --request PATCH \
    "https://app.pollinatorhub.eu/api/v1/datasets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"entities\": [
        \"euph\"
    ],
    \"name\": \"ISO 3166-1:2020\",
    \"long_name\": \"No-example\",
    \"description\": \"No-example\",
    \"status\": \"pending\",
    \"licence\": \"cc-by\",
    \"public\": true,
    \"published_at\": \"2023-07-04T11:24:58.000000Z\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'entities' => [
                'euph',
            ],
            'name' => 'ISO 3166-1:2020',
            'long_name' => 'No-example',
            'description' => 'No-example',
            'status' => 'pending',
            'licence' => 'cc-by',
            'public' => true,
            'published_at' => '2023-07-04T11:24:58.000000Z',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "entities": [
        "euph"
    ],
    "name": "ISO 3166-1:2020",
    "long_name": "No-example",
    "description": "No-example",
    "status": "pending",
    "licence": "cc-by",
    "public": true,
    "published_at": "2023-07-04T11:24:58.000000Z"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets/1'
payload = {
    "entities": [
        "euph"
    ],
    "name": "ISO 3166-1:2020",
    "long_name": "No-example",
    "description": "No-example",
    "status": "pending",
    "licence": "cc-by",
    "public": true,
    "published_at": "2023-07-04T11:24:58.000000Z"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/datasets/{dataset_id}

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

dataset_id integer

The ID of the dataset. Example: 1

Body Parameters

entities string[]

The UID of of an related Entity. The uid of an existing record in the user_entities table.

name string

The name of the Dataset Part. Must not be greater than 100 characters. Must be at least 3 characters. Example: ISO 3166-1:2020

long_name string

The long version of the name of the dataset. Must not be greater than 256 characters. Must be at least 8 characters. Example: No-example

description string

A longer description about the Dataset Part. Accepts Markdown for styling. Must not be greater than 15000000 characters. Must be at least 10 characters. Example: No-example

status string optional

The status of the dataset. Example: pending

Must be one of:

draft
pending

licence string optional

The UID of the licence of this entity. Example: cc-by

Must be one of:

cc-by-4-0
cc-by-sa-4-0
cc-by-nd-4-0
cc-by-nc-4-0
cc-by-nc-sa-4-0
cc-by-nc-nd-4-0
cc0-1-0
eurostat
cc-by-nc-sa-3.0-igo
statcube
table-specific-licence

public boolean true false

Setting this Dataset Part public attribute to true will make accessible to the public while setting it to false will make it only be used for processing. Example: true

published_at string optional

The date this Dataset Part can be published on the platform. A null value is allowed, having no or unknown publishing date. Must be a valid date. Example: 2023-07-04T11:24:58.000000Z

Delete dataset

requires authentication

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/datasets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Tables

Routes used to manage Dataset Tables.

List tables

requires authentication

Display a listing of Tables, the User has access to.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/datasets/1/parts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets/1/parts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets/1/parts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets/1/parts'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "name": "ISO 3166-1:2020",
            "description": "File iso3166_1_2020.csv contains 291 records of countries included in the ISO standard 3166-1:2020...",
            "uid": "DTST1.PRTA1.0",
            "type": "file",
            "licence_id": "unlicenced",
            "created_at": "2023-07-04T11:24:58.000000Z",
            "updated_at": "2023-07-04T11:24:58.000000Z"
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/datasets/{dataset_id}/parts

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

dataset_id integer

The ID of the dataset. Example: 1

dataset_uid string

The UID of the dataset to display related parts of.

Create table

requires authentication

Store a Dataset Part in storage.

Example request:

curl --request POST \
    "https://app.pollinatorhub.eu/api/v1/datasets/1/parts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ISO 3166-1:2020\",
    \"description\": \"No-example\",
    \"type\": \"api\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/datasets/1/parts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ISO 3166-1:2020',
            'description' => 'No-example',
            'type' => 'api',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/datasets/1/parts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ISO 3166-1:2020",
    "description": "No-example",
    "type": "api"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/datasets/1/parts'
payload = {
    "name": "ISO 3166-1:2020",
    "description": "No-example",
    "type": "api"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/datasets/{dataset_id}/parts

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

dataset_id integer

The ID of the dataset. Example: 1

Body Parameters

name string

The name of the Dataset Part. Must not be greater than 150 characters. Must be at least 3 characters. Example: ISO 3166-1:2020

description string

A longer description about the Dataset Part. Accepts Markdown for styling. Must not be greater than 15000000 characters. Must be at least 10 characters. Example: No-example

type string

The type this Dataset Part represents. Use 'api' when uploading data via the API. The list of available types are: api ,file ,files ,remote ,survey. Example: api

Must be one of:

file
files
remote
api
survey

Show table

requires authentication

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/parts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 51
access-control-allow-origin: *


{
    "data": {
        "id": 1,
        "name": "ISO 3166:2020",
        "type": "file",
        "description": "Data in this table was obtained from the International Organization for Standardization (ISO) Data, an independent, non-governmental international organization with a membership of 167 national standards bodies. It contains codes and names for the representation of names of countries and their subdivisions.",
        "dataset_uid": null,
        "licence": "euph",
        "published_at": null,
        "created_at": "2023-01-26T18:18:14.000000Z",
        "updated_at": "2024-01-26T17:32:58.000000Z"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Update table.

requires authentication

Example request:

curl --request PUT \
    "https://app.pollinatorhub.eu/api/v1/parts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ISO 3166-1:2020\",
    \"description\": \"No-example\",
    \"type\": \"api\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ISO 3166-1:2020',
            'description' => 'No-example',
            'type' => 'api',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ISO 3166-1:2020",
    "description": "No-example",
    "type": "api"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1'
payload = {
    "name": "ISO 3166-1:2020",
    "description": "No-example",
    "type": "api"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/parts/{id}

PATCH api/v1/parts/{id}

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The numeric identifier used to identify the Dataset Part within the platform. Example: 1

Body Parameters

name string

The name of the Dataset Part. Must not be greater than 150 characters. Must be at least 8 characters. Example: ISO 3166-1:2020

description string

A longer description about the Dataset Part. Accepts Markdown for styling. Must not be greater than 15000000 characters. Must be at least 10 characters. Example: No-example

type string

The type this Dataset Part represents. Use 'api' when uploading data via the API. The list of available types are: api ,file ,files ,remote ,survey. Example: api

Must be one of:

api
file
files
remote
survey

Delete table.

requires authentication

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/parts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Data

APIs for managing data records and values.

List Data

requires authentication

Display a listing of all data related to this Dataset Part. Is paginated..

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/parts/1/data?limit=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'limit' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1/data"
);

const params = {
    "limit": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data'
params = {
  'limit': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
resource-api-success: 
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "CNTRS2.ISOAB1.CNTRY6",
                    "value": 1,
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.NMRCC7",
                    "value": "10",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC9",
                    "value": "ANTARCTICA",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC10",
                    "value": "Antarctica",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.STTUS16",
                    "value": "Officially assigned",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SNNTT18",
                    "value": "Territories south of 60° south latitude.",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SNNTT19",
                    "value": "No subdivisions relevant for this standard.",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SNNTT20",
                    "value": "French Southern and Antarctic Territories (FQ, ATF, --) are now part of Antarctica and French Southern Territories (TF, ATF, 260). See also code element FQHH. Dronning Maud Land (NQ, ATN, 216) is now part of Antarctica. See also code element NQAQ.",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "Alpha2Code",
                    "value": "AQ",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN5",
                    "column": "Alpha3Code",
                    "value": "ATA",
                    "unit": null
                }
            ]
        },
        {
            "id": 2,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "CNTRS2.ISOAB1.CNTRY6",
                    "value": 2,
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.NMRCC7",
                    "value": "100",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.CNTRY8",
                    "value": "the Republic of Bulgaria",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC9",
                    "value": "BULGARIA",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC10",
                    "value": "Bulgaria",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.STTUS16",
                    "value": "Officially assigned",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "Alpha2Code",
                    "value": "BG",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN5",
                    "column": "Alpha3Code",
                    "value": "BGR",
                    "unit": null
                }
            ]
        },
        {
            "id": 3,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "CNTRS2.ISOAB1.CNTRY6",
                    "value": 3,
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.NMRCC7",
                    "value": "104",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.CNTRY8",
                    "value": "the Republic of the Union of Myanmar",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC9",
                    "value": "MYANMAR",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SHRTC10",
                    "value": "Myanmar",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.STTUS16",
                    "value": "Officially assigned",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SNNTT19",
                    "value": "Remark: the forms used in the list are English-language forms provided by Myanmar.",
                    "unit": null
                },
                {
                    "descriptor": "CNTRS2.ISOAB1.SNNTT20",
                    "value": "Name changed from former Burma (BU, BUR, 104) to Myanmar (MM MMR, 104). See code element BUMM.",
                    "unit": null
                }
            ]
        }
    ],
    "first_page_url": "https://pollinatorhub/api/v1/parts/1/data?page=1",
    "from": 1,
    "last_page": 97,
    "last_page_url": "https://pollinatorhub/api/v1/parts/1/data?page=97",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=8",
            "label": "8",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=9",
            "label": "9",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=10",
            "label": "10",
            "active": false
        },
        {
            "url": null,
            "label": "...",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=96",
            "label": "96",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=97",
            "label": "97",
            "active": false
        },
        {
            "url": "https://pollinatorhub/api/v1/parts/1/data?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://pollinatorhub/api/v1/parts/1/data?page=2",
    "path": "https://pollinatorhub/api/v1/parts/1/data",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 291
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/parts/{part_id}/data

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

part_id integer

The ID of the Dataset Part. Example: 1

Query Parameters

page integer optional

Chose the number of the page. Default 1.

limit integer optional

Chose the number of records to return per page (max 1000). Default 1000. Example: 3

Response

Response Fields

records object[]

List of Records.

* object

id integer

The record ID.

timestamp string

Timestamp this record was recorded at.

data object[]

List of data contained within the Record.

* object

descriptor string

The UID of the descriptor this datum represents.

value

The value of the datum.

origin

The UID of the Origin, this datum is related to. Can be null.

unit

The UID of the Unit, this datum is related to. Can be null.

Store Data

requires authentication

Store a set of records within provided Dataset Part.

Example request:

curl --request POST \
    "https://app.pollinatorhub.eu/api/v1/parts/1/data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"records\": [
        {
            \"timestamp\": \"2022-09-27 15:00:00\",
            \"data\": [
                {
                    \"descriptor\": \"0.0.NTSCD55\",
                    \"value\": \"BE100\",
                    \"unit\": \"kg\"
                }
            ]
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'records' => [
                [
                    'timestamp' => '2022-09-27 15:00:00',
                    'data' => [
                        [
                            'descriptor' => '0.0.NTSCD55',
                            'value' => 'BE100',
                            'unit' => 'kg',
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1/data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "records": [
        {
            "timestamp": "2022-09-27 15:00:00",
            "data": [
                {
                    "descriptor": "0.0.NTSCD55",
                    "value": "BE100",
                    "unit": "kg"
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data'
payload = {
    "records": [
        {
            "timestamp": "2022-09-27 15:00:00",
            "data": [
                {
                    "descriptor": "0.0.NTSCD55",
                    "value": "BE100",
                    "unit": "kg"
                }
            ]
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/parts/{part_id}/data

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

part_id integer

The ID of the Dataset Part. Example: 1

Body Parameters

records object[]

A list of records (rows) to be uploaded.

timestamp string

Time of measurement in ISO 8601 timestamp. Example: 2022-09-27 15:00:00

data object[]

A list of columns to insert. Must have at least 1 items.

descriptor string

UID of the descriptor. Example: 0.0.NTSCD55

Must be one of:

0.0.ARECD411
0.0.ARLBL412
0.0.BBLGR567
0.0.BBRVT409
0.0.BBRVT410
0.0.BEDAB738
0.0.BFRND501
0.0.BHVRA584
0.0.BHVRA585
0.0.BKPRD343
0.0.BLEAN316
0.0.BNSHB502
0.0.BSSFR572
0.0.CASTE586
0.0.CASTE587
0.0.CCPHC559
0.0.CCPHL560
0.0.CCPTD771
0.0.CCPTD772
0.0.CCRRN546
0.0.CCRRN594
0.0.CCRRN662
0.0.CCRRN663
0.0.CCRRN695
0.0.CCSSR566
0.0.CDABC524
0.0.CDFTH390
0.0.CLASS635
0.0.CLLCT569
0.0.CLLCT629
0.0.CLNDR376
0.0.CLNDR414
0.0.CLNDR415
0.0.CLNDR514
0.0.CLNYD362
0.0.CLTVR763
0.0.CNCNT399
0.0.CNMCV520
0.0.CNTNN614
0.0.CNTRY159
0.0.CNTRY736
0.0.CPCCD391
0.0.CPCCD426
0.0.CRDNT330
0.0.CRDNT725
0.0.CRDNT726
0.0.CSRGS389
0.0.CTGRF523
0.0.CTLGN703
0.0.CUNTY542
0.0.DATEA317
0.0.DAYAB382
0.0.DCMLN314
0.0.DGRFS589
0.0.DGRFS590
0.0.DMNCD416
0.0.DMNLB417
0.0.DNTFC406
0.0.DNTFC407
0.0.DNTFC600
0.0.DNTFC612
0.0.DNTFC613
0.0.DNTFC626
0.0.DNTFC755
0.0.DNTFC756
0.0.DNTFD531
0.0.DNTFD536
0.0.DNTFD578
0.0.DSPST591
0.0.DSPST592
0.0.DTDNT537
0.0.DTFLW549
0.0.DTGNR574
0.0.DTGNR588
0.0.DTNDT319
0.0.DTSTD335
0.0.DTSTN337
0.0.DWCNS557
0.0.DWCTY547
0.0.DWCVR435
0.0.DWCVR436
0.0.DYNMC573
0.0.EMAIL465
0.0.EVENT598
0.0.FLAGA421
0.0.FLDNM689
0.0.FLDNM690
0.0.FLDNT691
0.0.FLDNT692
0.0.FLGAB556
0.0.FLGDS422
0.0.FMILY508
0.0.FRMLT686
0.0.FRMTN740
0.0.FRQNC554
0.0.FSSLS606
0.0.FTPRN334
0.0.FTPRN615
0.0.FTPRN687
0.0.FTPRN688
0.0.FTPRN723
0.0.GBFTX336
0.0.GDPCN797
0.0.GDPCR796
0.0.GDTCD631
0.0.GDTCD632
0.0.GENUS509
0.0.GLGCL593
0.0.GNBNK515
0.0.GNRCN765
0.0.GRFRN582
0.0.GRFRN583
0.0.GRFRN616
0.0.GRFRN680
0.0.GRFRN681
0.0.GRFRN682
0.0.GRFRN683
0.0.GRFRN684
0.0.GRFRN685
0.0.GRFRN722
0.0.GROUP741
0.0.HBTAT678
0.0.HBTAT679
0.0.HGHRC766
0.0.HGHRG540
0.0.HGHRG737
0.0.HGHST743
0.0.HGHTB393
0.0.HMNBS608
0.0.HNYBD375
0.0.HNYBS223
0.0.HNYPR341
0.0.HNYYL458
0.0.HRFDY386
0.0.HSCDE427
0.0.HSCDE428
0.0.HVEID216
0.0.HVWGH33
0.0.ITMCD423
0.0.KNGDM633
0.0.LCLTY544
0.0.LCNSE564
0.0.LCODE73
0.0.LCTNA599
0.0.LCTNC672
0.0.LCTNC673
0.0.LCTND157
0.0.LCTNR727
0.0.LFSTG674
0.0.LFSTG675
0.0.LMNTC418
0.0.LMNTL419
0.0.LMTFQ434
0.0.LNDWR140
0.0.LNGGE548
0.0.LNGGE576
0.0.LNGTD332
0.0.LPHCN4
0.0.LPHCN5
0.0.LSTPD550
0.0.LTHST742
0.0.LTSTG676
0.0.LTSTG745
0.0.LTSTN753
0.0.LTSTP747
0.0.LTSTP749
0.0.LTSTR751
0.0.LTTDE333
0.0.LVNGS604
0.0.LWSTB744
0.0.MAREA519
0.0.MCHNB609
0.0.MCODE356
0.0.MDFDA545
0.0.MJRGR522
0.0.MMBER739
0.0.MNCPL132
0.0.MNCPL543
0.0.MNMMD729
0.0.MNMMD732
0.0.MNMML734
0.0.MNTHC793
0.0.MNTHD794
0.0.MONTH717
0.0.MSRMN602
0.0.MSRMN620
0.0.MSRMN621
0.0.MSRMN664
0.0.MSRMN665
0.0.MSRMN666
0.0.MSRMN667
0.0.MSRMN668
0.0.MSRMN669
0.0.MSRMN670
0.0.MSRMN671
0.0.MSRMN780
0.0.MSRMN781
0.0.MSRMN782
0.0.MSRMN784
0.0.MTRLC607
0.0.MTRLN596
0.0.MTRLN710
0.0.MTRLN713
0.0.MTRLS489
0.0.MTRLS597
0.0.MXMMD728
0.0.MXMMD731
0.0.MXMML733
0.0.NCLLC581
0.0.NDDYF719
0.0.NDSCR577
0.0.NDTST677
0.0.NDVDL701
0.0.NFLTN558
0.0.NFRGN764
0.0.NFRMT575
0.0.NFRMT630
0.0.NFRSP533
0.0.NITID86
0.0.NMBER457
0.0.NMBRF371
0.0.NMBRF485
0.0.NMBRF490
0.0.NMBRF491
0.0.NMBRF492
0.0.NMBRF494
0.0.NMBRF495
0.0.NMBRF496
0.0.NMBRF497
0.0.NMBRF498
0.0.NMBRF500
0.0.NMBRF563
0.0.NMCCR769
0.0.NMCCR774
0.0.NMNCL627
0.0.NMNCL758
0.0.NMPBL767
0.0.NMPBL768
0.0.NMPBL776
0.0.NSCDE504
0.0.NSLVL505
0.0.NSLVL506
0.0.NSTTT570
0.0.NTCDE561
0.0.NTGER313
0.0.NTLBL562
0.0.NTNME87
0.0.NTSCD55
0.0.NVRSL380
0.0.NXTME469
0.0.ORDER527
0.0.PDTFR551
0.0.PHCDE392
0.0.PHYLM634
0.0.PIARY456
0.0.PLTCL128
0.0.PNTRD724
0.0.PPLNC488
0.0.PPPCH525
0.0.PRNTM783
0.0.PRNTN775
0.0.PRNTN778
0.0.PRNTV716
0.0.PRPRT655
0.0.PRPRT656
0.0.PRSRV605
0.0.PRVSD705
0.0.PRYID342
0.0.PSTCD378
0.0.PTHWY657
0.0.PTHWY658
0.0.QNIDA486
0.0.QNRGH499
0.0.QNTFC467
0.0.RCRDC35
0.0.RCRDD344
0.0.RCRDD535
0.0.RCRDD579
0.0.RCRDD702
0.0.RCRDN34
0.0.RCRDN624
0.0.RDSCR430
0.0.RFRNC568
0.0.RGBDG487
0.0.RGHTS565
0.0.RGNLN773
0.0.RGNLN777
0.0.RGNSM595
0.0.RGNSM659
0.0.RGNSM660
0.0.RGNSM661
0.0.RGNSM704
0.0.RGNSM707
0.0.RGNSM708
0.0.RGNSM709
0.0.RLSTG610
0.0.RLSTG746
0.0.RLSTN754
0.0.RLSTP748
0.0.RLSTP750
0.0.RLSTR752
0.0.RLTDR789
0.0.RLTNS785
0.0.RLTNS786
0.0.RLTNS787
0.0.RLTNS788
0.0.RLTNS791
0.0.RLTVH395
0.0.RNFLL471
0.0.RNFLL473
0.0.RPRDC653
0.0.RPRDC654
0.0.RSRCD790
0.0.RSRCR603
0.0.RSRCR792
0.0.RTFSL478
0.0.SBFML528
0.0.SBGNS530
0.0.SBSTN526
0.0.SBTRB637
0.0.SCNTF503
0.0.SCNTF779
0.0.SCNTN256
0.0.SERID483
0.0.SEXAB534
0.0.SEXAB625
0.0.SLAND617
0.0.SLNDG618
0.0.SLRRR477
0.0.SMPLN539
0.0.SMPLN611
0.0.SMPLN715
0.0.SMPLS650
0.0.SMPLS651
0.0.SMPLS652
0.0.SNWFL472
0.0.SPCFC532
0.0.SPRFM636
0.0.SSCTD697
0.0.SSCTD698
0.0.SSCTD699
0.0.SSCTD700
0.0.SSCTD706
0.0.SSCTD711
0.0.SSONA466
0.0.STBLS622
0.0.STBLS623
0.0.STRTD718
0.0.STTPR541
0.0.TAXON601
0.0.TCFFS470
0.0.TEXTA315
0.0.THRCT696
0.0.TIMEA318
0.0.TMCDA553
0.0.TMDSC424
0.0.TMFDY464
0.0.TMLBL425
0.0.TMLBL552
0.0.TMPRT394
0.0.TMSPH396
0.0.TRIBE529
0.0.TTLLB555
0.0.TTXON580
0.0.TXNCN770
0.0.TXNID628
0.0.TXNMC759
0.0.TXNRM757
0.0.TXNRN762
0.0.TYPST648
0.0.TYPST649
0.0.UNITA94
0.0.UNTDS420
0.0.VNTDA493
0.0.VNTDT721
0.0.VNTRM714
0.0.VNTTM720
0.0.VNTTY693
0.0.VNTTY694
0.0.VRBTM484
0.0.VRBTM538
0.0.VRBTM642
0.0.VRBTM643
0.0.VRBTM644
0.0.VRBTM645
0.0.VRBTM646
0.0.VRBTM647
0.0.VRBTM712
0.0.VRBTM730
0.0.VRBTM735
0.0.VRBTM761
0.0.VRNCL760
0.0.VRRNF468
0.0.VRTCL640
0.0.VRTCL641
0.0.VTLTY638
0.0.VTLTY639
0.0.WGHTA521
0.0.WNDDR475
0.0.WNDGS476
0.0.WNDSP474
0.0.WNRNS571
0.0.WTRBD619
0.0.YEARA340
0.0.YERCD429
BGDBN192.SPCSB458.BGDBN192.0.0.0.RBSTN510
BGDBN192.SPCSC459.BGDBN192.0.0.0.CCRRN507
BGDBN192.SPCSV460.BGDBN192.0.0.0.VRGCV511
BGDGN199.0.PLTDA516
BGDGN199.0.SMPLP517
BGDGN200.0.PLTDA518
BGDHN193.0.RBSTN513
BGDHN193.0.VRGCV512
BKPNG8.0.CTVNG372
BKPNG8.0.CTVNG373
BKPNG8.0.DMNCD363
BKPNG8.0.FLGID368
BKPNG8.0.LMNTC364
BKPNG8.0.MNTHD370
BKPNG8.0.NITID367
BKPNG8.0.SRCDA369
BKPNG8.0.SRCHT374
BKPNG8.0.TMCDE365
BKPNG8.0.YRIDA366
BRDMN101.0.DVCDA463
BRDMN101.0.HMDTY446
BRDMN101.0.HMDTY447
BRDMN101.0.HMDTY448
BRDMN101.0.HMDTY449
BRDMN101.0.HMDTY450
BRDMN101.0.HMDTY451
BRDMN101.0.HVEID462
BRDMN101.0.LCTNA461
BRDMN101.0.PRYID459
BRDMN101.0.SERID460
BRDMN101.0.TMPRT439
BRDMN101.0.TMPRT440
BRDMN101.0.TMPRT441
BRDMN101.0.TMPRT442
BRDMN101.0.TMPRT443
BRDMN101.0.TMPRT444
BRDMN101.0.TMPRT445
BRDMN101.0.WGHTC455
BRDMN101.0.WGHTS452
BRDMN101.0.WGHTT453
BRDMN101.0.WGHTT454
BSCLD32.0.RPLCT398
BSCLD32.0.TRTMN397
BSCLD32.0.WGHTT401
BSCLD32.0.WGHTT402
BSCLD32.0.XPRMN405
CNTRS2.0.CNTRY2
CNTRS2.0.NMRCC1
CNTRS2.0.SHRTC3
CNTRS2.ISOAB1.CNTRY6
CNTRS2.ISOAB1.CNTRY8
CNTRS2.ISOAB1.NDDTE15
CNTRS2.ISOAB1.NMRCC7
CNTRS2.ISOAB1.SHRTC10
CNTRS2.ISOAB1.SHRTC9
CNTRS2.ISOAB1.SNNTT18
CNTRS2.ISOAB1.SNNTT19
CNTRS2.ISOAB1.SNNTT20
CNTRS2.ISOAB1.STRTD14
CNTRS2.ISOAB1.STTSN17
CNTRS2.ISOAB1.STTUS16
CNTRS2.UNSDM2.AREAA355
CNTRS2.UNSDM2.GLBLC347
CNTRS2.UNSDM2.GLBLN348
CNTRS2.UNSDM2.IDABC345
CNTRS2.UNSDM2.LDCAB359
CNTRS2.UNSDM2.LLDCA360
CNTRS2.UNSDM2.LNGGE346
CNTRS2.UNSDM2.NTRMR353
CNTRS2.UNSDM2.NTRMR354
CNTRS2.UNSDM2.RGNCD349
CNTRS2.UNSDM2.RGNNM350
CNTRS2.UNSDM2.SBRGN351
CNTRS2.UNSDM2.SBRGN352
CNTRS2.UNSDM2.SIDSA361
CRRNC5.ISOAB3.CRRNC79
CRRNC5.ISOAB3.DFNTN83
CRRNC5.ISOAB3.DTPBL85
CRRNC5.ISOAB3.IDABC76
CRRNC5.ISOAB3.LPHBT80
CRRNC5.ISOAB3.MNRNT82
CRRNC5.ISOAB3.NMRCC81
CRRNC5.ISOAB3.NTTYN78
CRRNC5.ISOAB3.WTHDR84
DVSNS29.0.DSCRP144
DVSNS29.0.KPGAB143
DVSNS29.0.SRCDA145
DVSNS29.HPGAB53.DSCRP141
DVSNS29.HPGAB53.SRCDA142
DVSNS29.LSTAT52.LAUAB134
DVSNS29.LSTAT52.MNCPL133
DVSNS29.LSTAT52.NUTSA136
DVSNS29.LSTAT52.PLTCL137
DVSNS29.LSTAT52.PLTCL138
DVSNS29.LSTAT52.PSTCD135
DVSNS29.LSTAT52.SRCDA139
DVSNS29.LTLPG55.HPGAB147
DVSNS29.LTLPG55.KPGAB148
DVSNS29.LTLPG55.MNCPL146
DVSNS29.LTLPG55.SRCDA149
DVSNS29.PLDST51.DSCRP130
DVSNS29.PLDST51.PLTCL129
DVSNS29.PLDST51.SRCDA131
HNYPL182.0.EMAIL480
HNYPL182.0.NMSRN479
HNYPL182.0.SSCTN482
HNYPL182.0.TLPHN481
HNYPR6.0.BKPER152
HNYPR6.0.HNYYL154
HNYPR6.0.HPGAB156
HNYPR6.0.IDABC150
HNYPR6.0.NUTSA155
HNYPR6.0.PIARY153
HNYPR6.0.YEARA151
LNGGE20.ISOAB46.FRNCH106
LNGGE20.ISOAB46.NAMEA105
LNGGE20.ISOAB46.SLPHD102
LNGGE20.ISOAB46.SLPHD103
LNGGE20.ISOAB46.SLPHD104
LNGGE20.ISOAB47.CMMNT114
LNGGE20.ISOAB47.RFRNC113
LNGGE20.ISOAB47.SCOPE111
LNGGE20.ISOAB47.SLPHD107
LNGGE20.ISOAB47.SLPHD108
LNGGE20.ISOAB47.SLPHD109
LNGGE20.ISOAB47.SLPHD110
LNGGE20.ISOAB47.TYPEA112
LNGGE20.LNGGS45.FFCLL100
LNGGE20.LNGGS45.NTNME99
LNGGE20.LNGGS45.PRCDR101
LNGGE20.LNGGS45.SLPHD98
LNGGE20.SMCRL48.LNGGD116
LNGGE20.SMCRL48.MCRLN115
LNGGE20.SMCRL48.STTSC117
LNGGE20.SNMES49.DNTFR118
LNGGE20.SNMES49.NVRTD121
LNGGE20.SNMES49.PRNTN120
LNGGE20.SNMES49.SLPHD119
LNGGE20.SRTRM50.CHNGT125
LNGGE20.SRTRM50.FFCTV127
LNGGE20.SRTRM50.LNGGN123
LNGGE20.SRTRM50.RTRMN124
LNGGE20.SRTRM50.RTRMN126
LNGGE20.SRTRM50.SLPHD122
NUTSA3.LAUAB44.DNTFR71
NUTSA3.LAUAB44.NAMEA74
NUTSA3.LAUAB44.NMNLT75
NUTSA3.NTSBR38.DNTFR45
NUTSA3.NTSBR38.DSCRP46
NUTSA3.NTSCS39.DNTFR47
NUTSA3.NTSCS39.DSCRP48
NUTSA3.NTSMN40.DNTFR49
NUTSA3.NTSMN40.DSCRP50
NUTSA3.NTSRB42.DNTFR53
NUTSA3.NTSRB42.DSCRP54
NUTSA3.NTSRM41.DNTFR51
NUTSA3.NTSRM41.DSCRP52
NUTSA3.NUTSA43.LEVEL58
NUTSA3.NUTSA43.MTRPL62
NUTSA3.NUTSA43.MTRPL63
NUTSA3.NUTSA43.NAMEA56
NUTSA3.NUTSA43.NMNLT57
NUTSA3.NUTSA43.SMTRP61
NUTSA3.NUTSA43.SSLND67
NUTSA3.NUTSA43.VLDFR69
NUTSA3.NUTSA43.VLDTO70
NUTSA3.NUTSA43.VRSNA59
NUTSA3.RNITS37.CLUMN43
NUTSA3.RNITS37.CLUMN44
NUTSA3.RNITS37.NTSCD438
NUTSA3.RNITS37.NTSLV37
NUTSA3.RNITS37.NTSLV38
NUTSA3.RNITS37.NTSLV39
NUTSA3.RNITS37.NTSLV40
NUTSA3.RNITS37.NTSLV41
NUTSA3.RNITS37.NTSLV42
PHRFR27.0.IMAGE331
PHRFR27.0.LCNCT408
PHRFR27.LCNCS36.BBRVT22
PHRFR27.LCNCS36.CRTDT30
PHRFR27.LCNCS36.DLTDT32
PHRFR27.LCNCS36.DNTFR21
PHRFR27.LCNCS36.LCNCD24
PHRFR27.LCNCS36.LCNCD26
PHRFR27.LCNCS36.LCNCN25
PHRFR27.LCNCS36.PDTDT31
PHRFR27.LCNCS36.SLUGA23
PHRFR27.LCNCS36.VLBLT29
PHRFR27.LCNCS36.XTRNL27
PHRFR27.LCNCS36.XTRNL28
PLLNT11.0.PLLNT11.0.0.0.MGEID795
PLLNT11.CRPGG73.CRPID388
UNITS7.UNITS4.BPMRF96
UNITS7.UNITS4.BSNIT91
UNITS7.UNITS4.CNVRS92
UNITS7.UNITS4.CNVRS93
UNITS7.UNITS4.NSDRF95
UNITS7.UNITS4.NTDSC90
UNITS7.UNITS4.QNTTY89
UNITS7.UNITS4.SRFRN97
UNITS7.UNITS4.STNDR88
VOTES100.0.MPDNT432
VOTES100.0.PLTCL433
VOTES100.0.VTDNT431
VTCSS14.0.CSNMB379
VTCSS14.0.SRCDA377

value string

The value of the column. Must be at least 1 character. Example: BE100

unit string optional

Optionally the name of the unit the value is provided in. By skipping this value a default is used based on the column type. Example: kg

Must be one of:

n.a.
%
% of total LSU
trillion EUR
billion EUR
million EUR
thousand EUR
EUR
EUR/kg
trillion USD
billion USD
million USD
thousand USD
USD
USD/m3
LCU
LCU/1000 kcal
LCU/J
LCU/t
LCU/kg
LCU/person/day
SLC
1000 I$
I$
I$/person
units/100 km2 land area
units/ha land area
km
m
dm
cm
mm
μm
nm
1000 ha
ha
m2
dm2
cm2
mm2
L
m3
1000 head
head
no./animal
million no.
thousand no.
no.
billion no.
1000 person
person
index
2u
12u
1000u
u
U (jeu/pack)
kcal/capita/day
J/capita/day
million kcal
kcal
Terajoule
1000 kWh
kWh
joule
electronvolt
watt
°C
Varroa mites/day
km/h
m/s
m/s2
year
month
week
day
hour
minute
second
100 mg/animal
hg/animal
mg/animal
hg/t
t/ha
hg/ha
kg/ha
kg/person
kg nutrients
g CH4/kg dry matter
kg CH4/head
g N2O/kg dry matter
kg N2O-N/ha
kg N2O-N/kg N
kg CO2eq/kg product
g/capita/day
Mt
kt
t
kg
hg
dag
g
mg
ng
carat
degree
angle minute
angle second
radian
steradian
ampere
volt
farad
ohm
siemens
mole
mole/m3
kelvin
hertz
newton
pascal
lux
becquerel
sievert
katal
kg/m3
m3/kg
candela
W/m2
cd/m2
coulomb
weber
tesla
henry
lumen
gray
/m
kg/m2
A/m2
A/m
Pa s
N m
N/m
rad/s
rad/s2
J/K
J/(K kg)
J/kg
W/(K m)
J/m3
V/m
C/m3
C/m2
F/m
H/m
J/mol
J/(K mol)
C/kg
Gy/s
W/sr
W/(sr m2)
kat/m3
astronomical unit
dalton
neper
bel
decibel
ADP
AED
AFA
AFN
ALK
ALL
AMD
ANG
AOA
AOK
AON
AOR
ARA
ARP
ARS
ARY
ATS
AUD
AWG
AYM
AZM
AZN
BAD
BAM
BBD
BDT
BEC
BEF
BEL
BGJ
BGK
BGL
BGN
BHD
BIF
BMD
BND
BOB
BOP
BOV
BRB
BRC
BRE
BRL
BRN
BRR
BSD
BTN
BUK
BWP
BYB
BYN
BYR
BZD
CAD
CDF
CHC
CHE
CHF
CHW
CLF
CLP
CNY
COP
COU
CRC
CSD
CSJ
CSK
CUC
CUP
CVE
CYP
CZK
DDM
DEM
DJF
DKK
DOP
DZD
ECS
ECV
EEK
EGP
ERN
ESA
ESB
ESP
ETB
FIM
FJD
FKP
FRF
GBP
GEK
GEL
GHC
GHP
GHS
GIP
GMD
GNE
GNF
GNS
GQE
GRD
GTQ
GWE
GWP
GYD
HKD
HNL
HRD
HRK
HTG
HUF
IDR
IEP
ILP
ILR
ILS
INR
IQD
IRR
ISJ
ISK
ITL
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAJ
LAK
LBP
LKR
LRD
LSL
LSM
LTL
LTT
LUC
LUF
LUL
LVL
LVR
LYD
MAD
MDL
MGA
MGF
MKD
MLF
MMK
MNT
MOP
MRO
MRU
MTL
MTP
MUR
MVQ
MVR
MWK
MXN
MXP
MXV
MYR
MZE
MZM
MZN
NAD
NGN
NIC
NIO
NLG
NOK
NPR
NZD
OMR
PAB
PEH
PEI
PEN
PES
PGK
PHP
PKR
PLN
PLZ
PTE
PYG
QAR
RHD
ROK
ROL
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDD
SDG
SDP
SEK
SGD
SHP
SIT
SKK
SLE
SLL
SOS
SRD
SRG
SSP
STD
STN
SUR
SVC
SYP
SZL
THB
TJR
TJS
TMM
TMT
TND
TOP
TPE
TRL
TRY
TTD
TWD
TZS
UAH
UAK
UGS
UGW
UGX
USN
USS
UYI
UYN
UYP
UYU
UYW
UZS
VEB
VED
VEF
VES
VNC
VND
VUV
WST
XAF
XAG
XAU
XBA
XBB
XBC
XBD
XCD
XDR
XEU
XFO
XFU
XOF
XPD
XPF
XPT
XRE
XSU
XTS
XUA
XXX
YDD
YER
YUD
YUM
YUN
ZAL
ZAR
ZMK
ZMW
ZRN
ZRZ
ZWC
ZWD
ZWL
ZWN
ZWR
hectopascal
g/m3
mg/L
ng/L
ug/L
ft
°F
no./day
Varroa mites/100 bees
spores per animal
mm/h
J/m2
J/cm2
dBm
mm3
°Bx
bp
AWUs
thousand AWUs

Delete all Data

requires authentication

Removes all data related to this Dataset Part.

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/parts/1/data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://app.pollinatorhub.eu/api/v1/parts/1/data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (204):

Empty response

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/parts/{part_id}/data

Headers

Authorization

Example: Bearer {YOUR_AUTH_KEY}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

part_id integer

The ID of the Dataset Part. Example: 1

Body Parameters

records object optional

Must not have more than 500 items.