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.

Health

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

Pipeline health check

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 "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' => [
            '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 = {
    "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 = {
  '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: 48
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.

Index

API Index

Index of the Restfull API. Returns a list of all second level routes, this api has to offer.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1';
$response = $client->get(
    $url,
    [
        'headers' => [
            '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"
);

const headers = {
    "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'
headers = {
  '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: 49
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1"
            },
            "health": {
                "href": "https://app.pollinatorhub.eu/api/v1/status"
            },
            "discovery": {
                "href": "https://app.pollinatorhub.eu/api/v1/discovery/datasets"
            },
            "entities": {
                "href": "https://app.pollinatorhub.eu/api/v1/entities",
                "auth": true
            },
            "datasets": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets",
                "auth": true
            }
        }
    }
}

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.

Discovery

List datasets

Get a list of all publicly accessible datasets. Does not return all metadata 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 "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' => [
            '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 = {
    "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 = {
  '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: 47
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/discovery/datasets/CNTRS2.0.0"
                }
            },
            "id": 2,
            "uid": "CNTRS2.0.0",
            "name": "Countries",
            "long_name": "EUPH reference dataset containing names and codes of countries, aggregates and subdivisions of countries",
            "description": "The dataset contains standardised information on countries published by the Organization for Standardization (ISO) and the United Nations Statistics Division (UNSD).",
            "featured_image": null,
            "status": "publish",
            "public": false,
            "licence": "EU Pollinator Hub",
            "published_at": "2023-01-25T23:00:00.000000Z",
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2025-04-18T09:44:15.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/discovery/datasets/LNGGE20.0.0"
                }
            },
            "id": 20,
            "uid": "LNGGE20.0.0",
            "name": "Language",
            "long_name": "Partial content of ISO 639 containing information on languages",
            "description": "This dataset contains information on languages spoken worldwide and contained in ISO 639-3:2007 (codes for the representation of names of languages — Part 3: Alpha-3 code for comprehensive coverage of languages) as well as official languages in the European Union, as defined in Regulation No 1 from 1958, as amended, determining the languages to be used by the European Economic Community.",
            "featured_image": null,
            "status": "publish",
            "public": false,
            "licence": "EU Pollinator Hub",
            "published_at": "2023-03-22T23:00:00.000000Z",
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2024-01-26T17:32:58.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/discovery/datasets/PHRFR27.0.0"
                }
            },
            "id": 27,
            "uid": "PHRFR27.0.0",
            "name": "EUPH Reference licences",
            "long_name": "List of licences by which datasets are published on the EU Pollinator Hub",
            "description": "The dataset contains all licences for data hosted on the EUPH.",
            "featured_image": null,
            "status": "publish",
            "public": false,
            "licence": "CC BY 4.0",
            "published_at": "2023-03-27T22:00:00.000000Z",
            "created_at": "2023-09-01T08:53:39.000000Z",
            "updated_at": "2024-02-01T14:25:03.000000Z"
        }
    ],
    "first_page_url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=1",
    "from": 1,
    "last_page": 7,
    "last_page_url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=7",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://app.pollinatorhub.eu/api/v1/discovery/datasets?page=2",
    "path": "https://app.pollinatorhub.eu/api/v1/discovery/datasets",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 20
}

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

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.

* 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.

description string

The abstract 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.

id integer

The internal id of the dataset.

Show dataset

Get detailed information about specific dataset.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/discovery/datasets/BGDBC176.0.0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/discovery/datasets/BGDBC176.0.0';
$response = $client->get(
    $url,
    [
        'headers' => [
            '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/BGDBC176.0.0"
);

const headers = {
    "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/BGDBC176.0.0'
headers = {
  '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: 46
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1/discovery/datasets/BGDBC176.0.0"
            }
        },
        "id": 176,
        "uid": "BGDBC176.0.0",
        "name": "B-GOOD Bee Counter Data",
        "long_name": "Dataset from the B-GOOD project, containing data from bee counters on daily exits and entrances of bees from colonies.",
        "description": "The dataset contains records of daily number of exits and entrances of bees from 6 colonies per location in 2023 in the locations Avignon/France (2023-03-31 – 2023-05-15), Halle/Germany (2023-05-17 – 2023-11-15) and Gent/Belgium (2023-06-02 – 2023-11-15). It was published by Alaux CA (INRAE) on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org) as part of the [B-GOOD project (grant agreement 817622)](https://b-good-project.eu/), funded under the [EU Horizon 2020 Research and Innovation Programme](https://research-and-innovation.ec.europa.eu/funding/funding-opportunities/funding-programmes-and-open-calls/horizon-2020_en).",
        "featured_image": null,
        "data_overview": "The data was published by Alaux CA (INRAE) on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org) as part of the [B-GOOD project (grant agreement 817622)](https://b-good-project.eu/), funded under the [EU Horizon 2020 Research and Innovation Programme](https://research-and-innovation.ec.europa.eu/funding/funding-opportunities/funding-programmes-and-open-calls/horizon-2020_en). It contains records of daily number of exits and entrances of bees from 6 colonies per location in 2023 in the locations Avignon/France (31.03.2023 – 15.11.2023), Halle/Germany (2023-05-17 – 2023-11-15) and Gent/Belgium (2023-06-02 – 2023-11-15).",
        "data_value": "The objectives of the B-GOOD project were: (1) Facilitate decision making for beekeepers and other stakeholders by establishing ready-to-use tools for operationalising the HSI; (2) Test, standardise and validate methods for measuring and reporting selected indicators affecting bee health; (3) Explore the various socio-economic and ecological factors beyond bee health; (4) Foster an EU community to collect and share knowledge related to honey bees and their environment; (5) Engender a lasting learning and innovation system (LIS); (6) Minimise the impact of biotic and abiotic stressors.",
        "data_description": "The dataset consists of one table (591,97 KB), which contains 6.960 records.",
        "data_application": "Currently, the data integrated from the [B-GOOD Bee Health Data Portal](https://beehealthdata.org/) contains maior issues and does not comply with the [FAIR Guiding Principles for scientific data management and stewardship](https://www.go-fair.org/fair-principles/) applied on the EU Pollinator Hub. More descriptive information about the context, quality and condition, or characteristics of the data (*e.g.* protocols, measurement devices used, units of the captured data, or any other details about the study) must be provided. More metadata in the form of accurate and relevant attributes (*e.g. *metadata that describes the scope of the data has been described, any particularities or limitations about the data that other users should be aware of, specification of the date of generation/collection of the data, the lab conditions, who prepared the data, the parameter settings, the name and version of the software used, specification of whether it is raw or processed data, explanation of all variable names are explained if they are not self-explanatory) must be provided. It requires major revisions by the data provider.",
        "data_issues": null,
        "introduction": "The data was published by Alaux CA (INRAE) on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org) as part of the [B-GOOD project (grant agreement 817622)](https://b-good-project.eu/), funded under the [EU Horizon 2020 Research and Innovation Programme](https://research-and-innovation.ec.europa.eu/funding/funding-opportunities/funding-programmes-and-open-calls/horizon-2020_en). The dataset contains records of daily number of exits and entrances of bees from 6 colonies per location in 2023 in the locations Avignon/France (31.03.2023 – 15.11.2023), Halle/Germany (17.05.2023 – 15.11.23) and Gent/Belgium (02.06.2023 – 15.11.23).\n\nThe objectives of the B-GOOD project were: (1) Facilitate decision making for beekeepers and other stakeholders by establishing ready-to-use tools for operationalising the HSI; (2) Test, standardise and validate methods for measuring and reporting selected indicators affecting bee health; (3) Explore the various socio-economic and ecological factors beyond bee health; (4) Foster an EU community to collect and share knowledge related to honey bees and their environment; (5) Engender a lasting learning and innovation system (LIS); (6) Minimise the impact of biotic and abiotic stressors.\n",
        "acquisition": "All raw data files were downloaded from the [B-GOOD Bee Health Data Portal](https://beehealthdata.org) on 2024-09-23 18:47:55.\n\n**List of raw data obtained from the data provider.**\n1. File *bee-counters-exen-daily-counts*, accessed on 2024-09-23 18:47:55, provided by [B-GOOD Bee Health Data Portal](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8)\n\nMetadata was obtained from the web pages of the dataset's [web page](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8).",
        "preparation": "The file in the zip-archive was extracted using File Explorer (Microsoft Corporation, version 22H2).\n\nThe file *GOOD_Virus_Data_2018_2020 Pool size.xlsx* was processed with MS Excel (Microsoft Corporation, version 2409). Column *date* was separated into column *time* and *date* and correctly formated to ISO 8601 format and the additional columns *city*, *NUTS3*, *device*, *device_ID* and *direction* were inserted and filled with the appropriate information. The worksheets were then exported to separate data files in CSV format (UTF-8 encoding) and imported into Notepad++ (version 8.7) where missing values were substituted by {NULL} using regular expressions. All data files were then merged using the Python script *[MergeCsv.py](https://app.pollinatorhub.eu/pages/specific-data-preparation)*. Finally, the merged data file was unpivoted using the Python script *[UnpivotToCsv.py](https://app.pollinatorhub.eu/pages/specific-data-preparation)*.\n\nData was then exported to the respective preparatory files and uploaded to the EU Pollinator Hub according to [SOP-017 (Dataset integration](https://app.pollinatorhub.eu/pages/sop-directory).",
        "validation": "No data validation was performed.",
        "analysis": "No data analysis was performed.",
        "status": "publish",
        "public": true,
        "licence": {
            "links": [],
            "uid": "cc-by-nc-nd-4-0",
            "name": "CC BY-NC-ND 4.0",
            "abbreviation": "CC BY-NC-ND 4.0",
            "description": "### You are free to:\n\n* Share — copy and redistribute the material in any medium or format.\n* The licensor cannot revoke these freedoms as long as you follow the license terms.\n\n### Under the following terms:\n\n* Attribution - You must give appropriate credit , provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.\n* NonCommercial - You may not use the material for commercial purposes.\n* NoDerivatives - If you remix, transform, or build upon the material, you may not distribute the modified material.\n* No additional restrictions - You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.\n\n### Notices:\n\nYou do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.\n\nNo warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.\n",
            "url_summary": "https://creativecommons.org/licenses/by-nc-nd/4.0",
            "url_legal": "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode",
            "image_url": "/storage/01HF964YD1M0APF9DSP8THPZSR.svg"
        },
        "contacts": [],
        "entities": [
            {
                "links": [],
                "id": 93,
                "uid": "b-good-bee-health-data-portal",
                "name": "B-GOOD Bee Health Data Portal",
                "type": "legal-entity",
                "abbreviation": "B-GOOD",
                "created_at": "2024-09-23T09:03:48.000000Z",
                "updated_at": "2024-11-03T11:12:48.000000Z"
            }
        ],
        "contributors": [],
        "parts": [
            {
                "links": {
                    "data": {
                        "href": "https://app.pollinatorhub.eu/api/v1/discovery/data/BGDBC176.BCNTR361.0"
                    }
                },
                "id": 361,
                "uid": "BGDBC176.BCNTR361.0",
                "name": "bee counter data",
                "description": "Daily number of exists and entrance of bees at colony level. The structure of the table provided by the B-GOOD Bee Health Data Portal has been modified and the data has been enriched in order to facilitate data standardisation as well as automated validation and analysis of the data.",
                "featured_image": null,
                "structure": null,
                "preparation": "1. Columns *city* and *NUTS3* were inserted. Values in the columns were derived from the metadata provided by the data owner on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8).\n2. Colum *time* was inserted. Values in columns *date* and *time* were derived from the datetime in column *date* in the raw data provided on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8). The meaning of the datetime was not specified by the data provider but there are good reasons to assume that this is the date and time of data transmission by the remote sensors, which did not occur at the same time in all records (either 01:00 or 02:00 am) . In order to facilitate automated data processing it has been decided to store date and time separately, as the exact time of transmission might be irrelevant.\n3. Column *device* was inserted. Values in column *device* were derived from the header of the values acquired with the respective device in the raw data provided on the [B-GOOD Bee Health Data Portal](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8)].\n4. Column *device_ID* was inserted. Values in column *device_ID* were derived from the assumed device name contained in column device.\n5. Column *direction* was inserted. Values in column *direction* were derived from the direction of movements of bees at the hive entrance ({in}: bees entering the beehive; {out}: bees leaving the beehive) extracted from the column device.\n",
                "changes": "1. In 138 records in which column *number* contained missing data (114 records for location INRAE, 18 records for location HALLE, 6 records for location GENT) it was replaced by {NULL}.",
                "unresolved": "1. Due to the missing description of the data it is unclear what the time provided with the date in the [raw data](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8) refers to. The data provider is requested to make this information available.\n2. It is unclear, whether the number of bees entering or leaving the beehive reported in the [raw data](https://beehealthdata.org/datasets/48186e29-93de-44c2-8d49-8d29c72857f8) refer to the date provided in column date or to the previous day, given that the time provided with the date (either 01:00 or 02:00) is often used as transmission time for remote devices. The data provider is requested to make this information available.\n3. Extreme outliers have been found in the number of bees entering and exiting the hive, which should be further investigated by the data provider.\n",
                "additional_information": null,
                "type": "file",
                "licence": null,
                "columns": [
                    {
                        "links": [],
                        "id": 2933,
                        "name": "location_name",
                        "description": "Name of the location, as assigned by the data owner, in which the values provided in the column *number* were measured.",
                        "descriptor": {
                            "links": [],
                            "id": 315,
                            "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.",
                            "class": "[EUPH-code: 7322]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:17:02.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:52.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2934,
                        "name": "city",
                        "description": "Name of the city where the honey bee colonies, in which the values provided in the column *number* were measured, were located.",
                        "descriptor": {
                            "links": [],
                            "id": 315,
                            "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.",
                            "class": "[EUPH-code: 7322]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:17:02.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2935,
                        "name": "NUTS3",
                        "description": "[NUTS level 3 code](https://app.pollinatorhub.eu/dictionary/classes/3328) of the region where the honey bee colonies, in which the values provided in the column *number* were measured, were located.",
                        "descriptor": {
                            "links": [],
                            "id": 55,
                            "uid": "0.0.NTSCD55",
                            "namespace": "eurostat",
                            "name": "nuts2021Code",
                            "description": "[A NUTS code](https://app.pollinatorhub.eu/vocabulary/classes/3328) defined in the [NUTS classification 2021](https://eur-lex.europa.eu/eli/reg_del/2019/1755/oj), valid from 2021-01-01 to 2023-12-31, containing 92 regions at NUTS level 1, 244 regions at NUTS level 2 and 1165 regions at NUTS level 3 level.",
                            "class": "[EUPH-code: 3369]",
                            "unit": null,
                            "created_at": "2023-09-01T06:53:40.000000Z",
                            "updated_at": "2025-03-25T22:09:00.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2936,
                        "name": "date",
                        "description": "[Calendar date](https://app.pollinatorhub.eu/dictionary/classes/7408) extracted from the colmun *date* in the raw data file of the data provider. Its exact meaning is not specified by the data provider. Presumably the [calendar date](https://app.pollinatorhub.eu/dictionary/classes/7408) on which the values provided in the column *number* were measured.",
                        "descriptor": {
                            "links": [],
                            "id": 317,
                            "uid": "0.0.DATEA317",
                            "namespace": "iso-8601",
                            "name": "calendarDate",
                            "description": "> particular [calendar day](https://app.pollinatorhub.eu/vocabulary/classes/3349) [...] represented by its [calendar year](https://app.pollinatorhub.eu/vocabulary/classes/3321) [...], its [calendar month](https://app.pollinatorhub.eu/vocabulary/classes/3342) [...] and its [calendar day of month](https://app.pollinatorhub.eu/vocabulary/classes/7407) [...]",
                            "class": "[EUPH-code: 7408]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2025-03-13T09:40:28.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2937,
                        "name": "time",
                        "description": "[Local time of day](https://app.pollinatorhub.eu/dictionary/classes/7417) extracted from the colmun *date* in the raw data of the data provider. Its exact meaning is not specified by the data provider. Presumably the [Local time of day](https://app.pollinatorhub.eu/dictionary/classes/7417) on which the values were transmitted by the remote sensing device.",
                        "descriptor": {
                            "links": [],
                            "id": 464,
                            "uid": "0.0.TMFDY464",
                            "namespace": "iso-8601",
                            "name": "localTimeOfDay",
                            "description": "> [time of day](https://app.pollinatorhub.eu/vocabulary/classes/7328) [...] in a [local time scale](https://app.pollinatorhub.eu/vocabulary/classes/7416) [...]",
                            "class": "[EUPH-code: 7417]",
                            "unit": null,
                            "created_at": "2024-09-23T14:53:06.000000Z",
                            "updated_at": "2025-02-06T11:32:36.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2938,
                        "name": "device",
                        "description": "Name of the device, used as header titles in the raw data file of the data provider, which was used to to measure the values provided in the column *number*.",
                        "descriptor": {
                            "links": [],
                            "id": 315,
                            "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.",
                            "class": "[EUPH-code: 7322]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:17:02.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2939,
                        "name": "device_ID",
                        "description": "Identifier of the device, extracted from the column *device*, which was used to measure the values provided in the column *number*.",
                        "descriptor": {
                            "links": [],
                            "id": 315,
                            "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.",
                            "class": "[EUPH-code: 7322]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:17:02.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2940,
                        "name": "direction",
                        "description": "Direction of movements of bees at the hive entrance ({in}: bees entering the beehive; {out}: bees leaving the beehive), extracted from the column *device*.",
                        "descriptor": {
                            "links": [],
                            "id": 315,
                            "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.",
                            "class": "[EUPH-code: 7322]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:17:02.000000Z"
                        },
                        "unit": null,
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    },
                    {
                        "links": [],
                        "id": 2941,
                        "name": "number",
                        "description": "Number of individual honey bees entering or leaving the beehive per day, as specified in column *direction*.",
                        "descriptor": {
                            "links": [],
                            "id": 313,
                            "uid": "0.0.NTGER313",
                            "namespace": null,
                            "name": "Integer",
                            "description": "> A number with no fractional part, including the negative and positive numbers as well as zero.",
                            "class": "[EUPH-code: 7324]",
                            "unit": null,
                            "created_at": null,
                            "updated_at": "2024-09-14T11:14:52.000000Z"
                        },
                        "unit": {
                            "links": [],
                            "name": "no./day",
                            "standardised_notation": "no. day<sup>-1</sup>",
                            "quantity_description": "amount",
                            "unit_description": "number per day",
                            "base_unit": "no./day",
                            "conversion_function": null,
                            "conversion_factor": null
                        },
                        "datatype": null,
                        "order": 0,
                        "created_at": "2024-09-23T13:22:54.000000Z",
                        "updated_at": "2024-11-27T14:48:16.000000Z"
                    }
                ],
                "data_files": [
                    {
                        "links": [],
                        "id": 474,
                        "name": "b-good bee counter data_PREP_MR_240923.csv",
                        "description": null,
                        "status": "completed",
                        "type": "csv",
                        "mimetype": "text/csv",
                        "file_size": 606181,
                        "download_count": 0,
                        "created_at": "2024-09-23T13:23:18.000000Z",
                        "updated_at": "2025-08-27T14:13:51.000000Z"
                    }
                ],
                "supplemental_files": [],
                "created_at": "2024-09-23T13:11:15.000000Z",
                "updated_at": "2025-04-18T09:44:16.000000Z"
            }
        ],
        "descriptors": [
            {
                "links": [],
                "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"
            },
            {
                "links": [],
                "uid": "0.0.NTSCD55",
                "namespace": "eurostat",
                "name": "nuts2021Code",
                "description": "[A NUTS code](https://app.pollinatorhub.eu/vocabulary/classes/3328) defined in the [NUTS classification 2021](https://eur-lex.europa.eu/eli/reg_del/2019/1755/oj), valid from 2021-01-01 to 2023-12-31, containing 92 regions at NUTS level 1, 244 regions at NUTS level 2 and 1165 regions at NUTS level 3 level.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 3369]",
                "unit": null,
                "deprecated": false,
                "created_at": "2023-09-01T06:53:40.000000Z",
                "updated_at": "2025-03-25T22:09:00.000000Z"
            },
            {
                "links": [],
                "uid": "0.0.DATEA317",
                "namespace": "iso-8601",
                "name": "calendarDate",
                "description": "> particular [calendar day](https://app.pollinatorhub.eu/vocabulary/classes/3349) [...] represented by its [calendar year](https://app.pollinatorhub.eu/vocabulary/classes/3321) [...], its [calendar month](https://app.pollinatorhub.eu/vocabulary/classes/3342) [...] and its [calendar day of month](https://app.pollinatorhub.eu/vocabulary/classes/7407) [...]",
                "notes": "Recommended best practice is to provide the date in the [extended format](https://app.pollinatorhub.eu/vocabulary/classes/868), as proposed by ISO 8601 ([YYYY][\"-\"][MM][\"-\"][DD]), where [YYYY] is a format representation of a [calendar year](https://app.pollinatorhub.eu/vocabulary/classes/3321), [MM] is a format representation of a [calendar month](https://app.pollinatorhub.eu/vocabulary/classes/3342) and [DD] is a format representation of a [calendar day](https://app.pollinatorhub.eu/vocabulary/classes/3349).",
                "examples": "* 2025-03-13",
                "class": "[EUPH-code: 7408]",
                "unit": null,
                "deprecated": false,
                "created_at": null,
                "updated_at": "2025-03-13T09:40:28.000000Z"
            },
            {
                "links": [],
                "uid": "0.0.TMFDY464",
                "namespace": "iso-8601",
                "name": "localTimeOfDay",
                "description": "> [time of day](https://app.pollinatorhub.eu/vocabulary/classes/7328) [...] in a [local time scale](https://app.pollinatorhub.eu/vocabulary/classes/7416) [...]",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 7417]",
                "unit": null,
                "deprecated": false,
                "created_at": "2024-09-23T14:53:06.000000Z",
                "updated_at": "2025-02-06T11:32:36.000000Z"
            },
            {
                "links": [],
                "uid": "0.0.NTGER313",
                "namespace": null,
                "name": "Integer",
                "description": "> A number with no fractional part, including the negative and positive numbers as well as zero.",
                "notes": null,
                "examples": null,
                "class": "[EUPH-code: 7324]",
                "unit": null,
                "deprecated": false,
                "created_at": null,
                "updated_at": "2024-09-14T11:14:52.000000Z"
            }
        ],
        "published_at": "2025-03-16T23:00:00.000000Z",
        "created_at": "2024-09-23T09:28:22.000000Z",
        "updated_at": "2025-08-27T14:13:51.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 metadata associated with the requested dataset.

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

Abstract about the dataset. Uses Markdown for styling.

data_overview string

Concise information (less than 200 words) about: e.g. provider of the data (who?); origin of the data and the subject area covered by the dataset (what?); geographical origin of the data (where?); time period covered by the dataset (when?). Uses Markdown for styling.

data_value string

Concise information (less than 200 words) about: e.g. reason for collecting the data; possible benefits resulting from the collection of the data (why?). Uses Markdown for styling.

data_description string

Concise description (less than 200 words) of the dataset metrics: e.g. number of files; categories of data; size of the datasets in bytes. Uses Markdown for styling.

data_application string

A concise summary (less than 200 words) of possible applications for which the data could be used, scientific or technical questions or other issues that could be addressed (for what?). Uses Markdown for styling.

data_issues string

A list of unresolved issues and quality concerns. Uses Markdown for styling.

introduction string

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

acquisition string

Description of or a reference to material and methods used to acquire the data in the dataset and a detailed list of terms under which the data has been made available (licensing).Uses Markdown for styling.

preparation string

Detailed description of material (product, model) and methods (provide references if possible) used to prepare the dataset. Uses Markdown for styling.

validation string

Detailed description of material (product, model) and methods (provide references if possible) used to validate the dataset for the purpose of data quality assessment. Uses Markdown for styling.

analysis string

Detailed description of material (product, model) and methods (provide references if possible) used to analyse the dataset for the purpose of data quality assessment. 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

Value of 1 means that the data of this dataset are publicly accessible.

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 is 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.

structure string

An unordered list of potential links between columns of the same file, of different files of the same dataset or of different files of different datasets as follows: Column [dataset].[file].[column] links on [dataset].[file].[column]. Uses Markdown for styling.

preparation string

It contains an unordered list of all changes made in the preparatory file described in the parent section according to Directory-006 (Dataset preparation). Uses Markdown for styling.

changes string

It contains an unordered list of all changes made in the data after integration of the file described in the parent section into the EUPH according to Directory-006 (Dataset preparation). Uses Markdown for styling.

unresolved string

It contains an unordered list of all unresolved issues in the file of the parent section requiring intervention by the data provider according to Directory-007 (Data profiling). 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.

id integer

Numeric identifier of the table.

descriptors string[]

An array of all descriptors, used to integrate this dataset. Field is 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

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 "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' => [
            '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 = {
    "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 = {
  '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: 45
access-control-allow-origin: *


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

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 the specified page to view the results. Default: 1

limit integer optional

Set the number 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|null

The name of the column, the value was imported from. Can be null when streamed via API.

column_id int|null

The internal id of the column. Can be null when streamed via API.

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: 43
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/13",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/13",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/13",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 13,
            "uid": "boe",
            "name": "Biene Österreich – Imkereidachverband",
            "type": "legal-entity",
            "abbreviation": " BÖ",
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2025-07-14T18:10:14.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 3,
            "uid": "euph",
            "name": "EU Pollinator Hub",
            "type": "legal-entity",
            "abbreviation": "EUPH",
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2024-06-04T12:59:02.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/14",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/14",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/entities/14",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 14,
            "uid": "efsa",
            "name": "European Food Safety Authority",
            "type": "legal-entity",
            "abbreviation": "EFSA",
            "created_at": "2023-10-05T10:02:30.000000Z",
            "updated_at": "2025-07-14T20:19:45.000000Z"
        }
    ],
    "first_page_url": "https://app.pollinatorhub.eu/api/v1/entities?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "https://app.pollinatorhub.eu/api/v1/entities?page=2",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/entities?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/entities?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/entities?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://app.pollinatorhub.eu/api/v1/entities?page=2",
    "path": "https://app.pollinatorhub.eu/api/v1/entities",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 5
}

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

id integer

Numeric identifier of the entity.

uid string

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

name string

A descriptive name of the entity.

abbreviation string

Abbreviation or short name of the entity.

type string

Type of the Entity. Can be 'person' or 'legal-entity'.

created_at string

The date and time the entity was created.

updated_at string

The date and time the entity was last updated.

Create Entity

requires authentication

Create a new entity to be used and interact with.

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, John\",
    \"first_name\": \"Doe\",
    \"abbreviation\": \"EFSA\",
    \"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, John',
            'first_name' => 'Doe',
            'abbreviation' => 'EFSA',
            '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, John",
    "first_name": "Doe",
    "abbreviation": "EFSA",
    "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, John",
    "first_name": "Doe",
    "abbreviation": "EFSA",
    "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 legal entity or person. Must not be greater than 250 characters. Must be at least 4 characters. Example: European Food Safety Authority, John

first_name string optional

First name of a person. If type is legal, this field is null. This field is required when type is person. Must not be greater than 250 characters. Must be at least 4 characters. Example: Doe

abbreviation string optional

Abbreviation or short name of the legal entity. If type is person, this field is null. This field is required when type is legal-entity. Must not be greater than 10 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 15000 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 optional

A longer description about the entity. Accepts Markdown for styling. Must not be greater than 15000 characters.

country_id string

A two-letter ISO 3166 code that represents a country name. Must be 2 characters. Example: IT

Must be one of:

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

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, url-research-gate, url-orcid. Example: email

value string

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

type string

Example: legal-entity

Must be one of:

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: 42
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                "auth": true
            },
            "update": {
                "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                "method": "PUT/PATCH",
                "auth": true
            },
            "delete": {
                "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                "method": "DELETE",
                "auth": true
            }
        },
        "id": 3,
        "uid": "euph",
        "name": "EU Pollinator Hub",
        "type": "legal-entity",
        "first_name": null,
        "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,
        "featured_image": "https://app.pollinatorhub.eu/storage/entities/01HZHN8AQYJDJ2SV1Z8X3XS661.jpg",
        "contacts": [
            {
                "links": [],
                "type": "url-linkedin",
                "value": "https://www.linkedin.com/company/beelife-european-beekeeping-coordination/"
            },
            {
                "links": [],
                "type": "url",
                "value": "https://pollinatorhub.eu"
            }
        ],
        "country": {
            "iso-3166:shortLowercaseNameOfCountry": "Belgium",
            "full_name": "the Kingdom of Belgium",
            "unsd:m49Area": "56",
            "iso-3166:alpha-2CountryCode": "BE",
            "iso-3166:alpha-3CountryCode": "BEL"
        },
        "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 string[]

A list of entities available to the User.

id integer

Numeric identifier of the entity.

name string

A descriptive name of 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|null

Abbreviation or short name of the entity.

registry_number string|null

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

description string|null

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

address string|null

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

featured_image string|null

Url to the featured image.

country object

Country the entity resides in.

full_name string

Full name of the country.

iso-3166:shortLowercaseNameOfCountry string

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

unsd:m49Area string

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

iso-3166:alpha-2CountryCode string

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

iso-3166:alpha-3CountryCode string

A three-letter code that represents a country name.

type string

Type of the Entity. Can be 'person' or 'legal-entity'.

created_at string

The date and time the entity was created.

updated_at string

The date and time the entity was last updated.

Update Entity

requires authentication

Update entity metadata.

Example request:

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

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/entities/aut';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'European Food Safety Authority, John',
            'first_name' => 'Doe',
            'abbreviation' => 'EFSA',
            '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/aut"
);

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

let body = {
    "name": "European Food Safety Authority, John",
    "first_name": "Doe",
    "abbreviation": "EFSA",
    "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/aut'
payload = {
    "name": "European Food Safety Authority, John",
    "first_name": "Doe",
    "abbreviation": "EFSA",
    "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: aut

Body Parameters

name string

A descriptive name of the legal entity or person. Must not be greater than 250 characters. Must be at least 4 characters. Example: European Food Safety Authority, John

first_name string optional

First name of a person. If type is legal, this field is null. This field is required when type is person. Must not be greater than 250 characters. Must be at least 4 characters. Example: Doe

abbreviation string optional

Abbreviation or short name of the legal entity. If type is person, this field is null. This field is required when type is legal-entity. Must not be greater than 10 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 15000 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 optional

A longer description about the entity. Accepts Markdown for styling. Must not be greater than 15000 characters.

country_id string

A two-letter ISO 3166 code that represents a country name. Must be 2 characters. Example: IT

Must be one of:

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

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, url-research-gate, url-orcid. Example: email

value string

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

Delete entity

requires authentication

Delete selected entity. Note, an entity with associated datasets can not be deleted.

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/entities/doloribus" \
    --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/doloribus';
$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/doloribus"
);

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/doloribus'
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: 41
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/6",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/6",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/6",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 6,
            "uid": "HNYPR6.0.0",
            "name": "Honey production Austria",
            "long_name": "Honey production in Austria",
            "description": "The dataset contains anonymised total annual honey yields of test colonies from the performance testing scheme of the Austrian honey bee breeding program. The locations of apiaries were aggregated by NUTS level 1 and HPG.",
            "featured_image": null,
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-04-16T22:00:00.000000Z",
            "created_at": "2023-01-26T18:18:06.000000Z",
            "updated_at": "2025-08-18T11:00:17.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/8",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/8",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/8",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 8,
            "uid": "BKPNG8.0.0",
            "name": "Beekeeping Austria",
            "long_name": "Collection of data related to honey bees in Austria.",
            "description": "This dataset is a collection of data related to honey bees (*Apis mellifera* L.) in Austria.",
            "featured_image": null,
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-11-30T23:00:00.000000Z",
            "created_at": "2022-04-27T07:15:00.000000Z",
            "updated_at": "2025-08-28T08:25:25.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/14",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/14",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/datasets/14",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 14,
            "uid": "VTCSS14.0.0",
            "name": "Vetcases",
            "long_name": "Reports of notifiable diseases reported for Apis mellifera",
            "description": "This dataset contains data from various sources on the outbreak of notifiable diseases reported for honey bees (*Apis mellifera*) in Belgium and Austria from 2000 to 2022.",
            "featured_image": "https://app.pollinatorhub.eu/storage/providers/01HHF30JC0SSJRQESPPWNJG3F5.png",
            "status": "publish",
            "public": true,
            "licence": "CC BY-NC-SA 4.0",
            "published_at": "2023-06-12T22:00:00.000000Z",
            "created_at": "2023-02-08T15:11:52.000000Z",
            "updated_at": "2025-04-18T09:44:16.000000Z"
        }
    ],
    "first_page_url": "https://app.pollinatorhub.eu/api/v1/datasets?page=1",
    "from": 1,
    "last_page": 25,
    "last_page_url": "https://app.pollinatorhub.eu/api/v1/datasets?page=25",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=8",
            "label": "8",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=9",
            "label": "9",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=10",
            "label": "10",
            "active": false
        },
        {
            "url": null,
            "label": "...",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=24",
            "label": "24",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=25",
            "label": "25",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/datasets?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://app.pollinatorhub.eu/api/v1/datasets?page=2",
    "path": "https://app.pollinatorhub.eu/api/v1/datasets",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 74
}

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.

* object

id integer

Numeric identifier of the dataset.

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

uid string

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

description string

Dataset abstract. Uses Markdown for styling.

featured_image string|null

URL to uploaded image representing this 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. /

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\",
    \"description\": \"Sunt corrupti iste veritatis expedita.\",
    \"data_overview\": \"ndoozlzrf\",
    \"data_value\": \"rcqbedrkm\",
    \"data_description\": \"qnusnleqctznrpqqciyqshee\",
    \"data_application\": \"jawettmtajslgwqltmgujium\",
    \"data_issues\": \"kkijdkdayfkavmftluwngvf\",
    \"introduction\": \"lejkyorlrvhiwtplrmkf\",
    \"acquisition\": \"nyqidbay\",
    \"preparation\": \"lzdmiiwphawckdprwnhfb\",
    \"validation\": \"wimeneygluoannpd\",
    \"analysis\": \"izsurlfnofqlzq\",
    \"licence\": \"cc-by\",
    \"entities\": [
        \"euph\"
    ],
    \"public\": true,
    \"published_at\": \"2023-07-04T11:24:58.000000Z\",
    \"contacts\": [
        {
            \"type\": \"url-linkedin\",
            \"value\": \"egbxwsraqrlmatosgzaiyvddffcuzkprnfvagxuffmaxixokdyixeegbkarjuhqwodtwejsbyshuo\"
        }
    ]
}"

$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',
            'description' => 'Sunt corrupti iste veritatis expedita.',
            'data_overview' => 'ndoozlzrf',
            'data_value' => 'rcqbedrkm',
            'data_description' => 'qnusnleqctznrpqqciyqshee',
            'data_application' => 'jawettmtajslgwqltmgujium',
            'data_issues' => 'kkijdkdayfkavmftluwngvf',
            'introduction' => 'lejkyorlrvhiwtplrmkf',
            'acquisition' => 'nyqidbay',
            'preparation' => 'lzdmiiwphawckdprwnhfb',
            'validation' => 'wimeneygluoannpd',
            'analysis' => 'izsurlfnofqlzq',
            'licence' => 'cc-by',
            'entities' => [
                'euph',
            ],
            'public' => true,
            'published_at' => '2023-07-04T11:24:58.000000Z',
            'contacts' => [
                [
                    'type' => 'url-linkedin',
                    'value' => 'egbxwsraqrlmatosgzaiyvddffcuzkprnfvagxuffmaxixokdyixeegbkarjuhqwodtwejsbyshuo',
                ],
            ],
        ],
    ]
);
$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",
    "description": "Sunt corrupti iste veritatis expedita.",
    "data_overview": "ndoozlzrf",
    "data_value": "rcqbedrkm",
    "data_description": "qnusnleqctznrpqqciyqshee",
    "data_application": "jawettmtajslgwqltmgujium",
    "data_issues": "kkijdkdayfkavmftluwngvf",
    "introduction": "lejkyorlrvhiwtplrmkf",
    "acquisition": "nyqidbay",
    "preparation": "lzdmiiwphawckdprwnhfb",
    "validation": "wimeneygluoannpd",
    "analysis": "izsurlfnofqlzq",
    "licence": "cc-by",
    "entities": [
        "euph"
    ],
    "public": true,
    "published_at": "2023-07-04T11:24:58.000000Z",
    "contacts": [
        {
            "type": "url-linkedin",
            "value": "egbxwsraqrlmatosgzaiyvddffcuzkprnfvagxuffmaxixokdyixeegbkarjuhqwodtwejsbyshuo"
        }
    ]
};

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",
    "description": "Sunt corrupti iste veritatis expedita.",
    "data_overview": "ndoozlzrf",
    "data_value": "rcqbedrkm",
    "data_description": "qnusnleqctznrpqqciyqshee",
    "data_application": "jawettmtajslgwqltmgujium",
    "data_issues": "kkijdkdayfkavmftluwngvf",
    "introduction": "lejkyorlrvhiwtplrmkf",
    "acquisition": "nyqidbay",
    "preparation": "lzdmiiwphawckdprwnhfb",
    "validation": "wimeneygluoannpd",
    "analysis": "izsurlfnofqlzq",
    "licence": "cc-by",
    "entities": [
        "euph"
    ],
    "public": true,
    "published_at": "2023-07-04T11:24:58.000000Z",
    "contacts": [
        {
            "type": "url-linkedin",
            "value": "egbxwsraqrlmatosgzaiyvddffcuzkprnfvagxuffmaxixokdyixeegbkarjuhqwodtwejsbyshuo"
        }
    ]
}
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 optional

The long version of the name of the dataset. Must not be greater than 256 characters. Must be at least 5 characters.

description string optional

Abstract about the dataset. Uses Markdown for styling. Must not be greater than 150000 characters. Example: Sunt corrupti iste veritatis expedita.

data_overview string optional

data_value string optional

Concise information (less than 200 words) about: e.g. reason for collecting the data; possible benefits resulting from the collection of the data (why?). Uses Markdown for styling. Must not be greater than 150000 characters. Example: rcqbedrkm

data_description string optional

Concise description (less than 200 words) of the dataset metrics: e.g. number of files; categories of data; size of the datasets in bytes. Uses Markdown for styling. Must not be greater than 150000 characters. Example: qnusnleqctznrpqqciyqshee

data_application string optional

data_issues string optional

A list of unresolved issues and quality concerns. Uses Markdown for styling. Must not be greater than 150000 characters. Example: kkijdkdayfkavmftluwngvf

introduction string optional

A longer description about the dataset. Uses Markdown for styling. Must not be greater than 150000 characters. Example: lejkyorlrvhiwtplrmkf

acquisition string optional

preparation string optional

Detailed description of material (product, model) and methods (provide references if possible) used to prepare the dataset. Uses Markdown for styling. Must not be greater than 150000 characters. Example: lzdmiiwphawckdprwnhfb

validation string optional

Detailed description of material (product, model) and methods (provide references if possible) used to validate the dataset for the purpose of data quality assessment. Uses Markdown for styling. Must not be greater than 150000 characters. Example: wimeneygluoannpd

analysis string optional

etailed description of material (product, model) and methods (provide references if possible) used to analyse the dataset for the purpose of data quality assessment. Uses Markdown for styling. Must not be greater than 150000 characters. Example: izsurlfnofqlzq

licence string optional

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

Must be one of:

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

entities string[]

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

contacts object[] optional

type string

Example: url-linkedin

Must be one of:

address
email
phone
url
url-facebook
url-linkedin
url-orcid
url-research-gate
url-twitter
url-vimeo
url-youtube

value string

Must be at least 5 characters. Example: egbxwsraqrlmatosgzaiyvddffcuzkprnfvagxuffmaxixokdyixeegbkarjuhqwodtwejsbyshuo

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

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/4" \
    --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/4';
$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/4"
);

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/4'
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: 40
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets/4",
                "auth": true
            },
            "update": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets/4",
                "method": "PUT/PATCH",
                "auth": true
            },
            "delete": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets/4",
                "method": "DELETE",
                "auth": true
            },
            "parts.index": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets/4/parts",
                "auth": true
            },
            "parts.create": {
                "href": "https://app.pollinatorhub.eu/api/v1/datasets/4/parts",
                "method": "POST",
                "auth": true
            }
        },
        "id": 4,
        "uid": "PSTCD4.0.0",
        "name": "Postcode",
        "long_name": "Postcodes from various countries",
        "description": "The dataset contains postcodes from 97 countries for internal use on the EUPH.",
        "featured_image": null,
        "data_overview": null,
        "data_value": null,
        "data_description": null,
        "data_application": null,
        "data_issues": null,
        "introduction": null,
        "acquisition": null,
        "preparation": null,
        "validation": null,
        "analysis": null,
        "status": "publish",
        "public": false,
        "licence": {
            "links": [],
            "uid": "cc-by-4-0",
            "name": "CC BY 4.0",
            "abbreviation": "CC BY 4.0",
            "description": "### You are free to:\n\n* Share — copy and redistribute the material in any medium or format for any purpose, even commercially.\n* Adapt — remix, transform, and build upon the material for any purpose, even commercially.\n* The licensor cannot revoke these freedoms as long as you follow the license terms.\n\n### Under the following terms:\n\n* Attribution - You must give appropriate credit , provide a link to the license, and indicate if changes were made . You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.\n* No additional restrictions - You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.\n\n### Notices:\n\nYou do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.\n\nNo warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.\n",
            "url_summary": "https://creativecommons.org/licenses/by/4.0/",
            "url_legal": "https://creativecommons.org/licenses/by/4.0/legalcode",
            "image_url": "/storage/01HF961C5YQASH3TQ6MNYKN9WN.svg"
        },
        "contacts": [],
        "entities": [
            {
                "links": {
                    "self": {
                        "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                        "auth": true
                    },
                    "update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/entities/3",
                        "method": "DELETE",
                        "auth": true
                    }
                },
                "id": 3,
                "uid": "euph",
                "name": "EU Pollinator Hub",
                "type": "legal-entity",
                "abbreviation": "EUPH",
                "created_at": "2023-10-05T10:02:30.000000Z",
                "updated_at": "2024-06-04T12:59:02.000000Z"
            }
        ],
        "contributors": [],
        "parts": [
            {
                "links": {
                    "self": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72",
                        "auth": true
                    },
                    "update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72",
                        "method": "DELETE",
                        "auth": true
                    },
                    "columns.index": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/columns",
                        "auth": true
                    },
                    "columns.create": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/columns",
                        "method": "POST",
                        "auth": true
                    },
                    "data.index": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/data",
                        "auth": true
                    },
                    "data.create": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/data",
                        "method": "POST",
                        "auth": true
                    },
                    "data.update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/data",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "data.delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/parts/72/data",
                        "method": "DELETE",
                        "auth": true
                    }
                },
                "id": 72,
                "uid": "PSTCD4.WRLDW72.0",
                "name": "Worldwide postcodes",
                "description": "The table contains postcodes from 97 countries.",
                "featured_image": null,
                "type": "file",
                "licence": "cc-by-4-0",
                "created_at": "2023-10-05T07:59:13.000000Z",
                "updated_at": "2024-01-25T09:26:57.000000Z"
            }
        ],
        "descriptors": [],
        "published_at": "2023-09-12T22:00:00.000000Z",
        "created_at": "2023-01-26T18:18:06.000000Z",
        "updated_at": "2024-01-26T19:17:49.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 metadata associated with the requested dataset.

id integer

Numeric identifier of the dataset.

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

Abstract about the dataset. Uses Markdown for styling.

featured_image string|null

URL to uploaded image representing this dataset.

data_overview string

data_value string

Concise information (less than 200 words) about: e.g. reason for collecting the data; possible benefits resulting from the collection of the data (why?). Uses Markdown for styling.

data_description string

Concise description (less than 200 words) of the dataset metrics: e.g. number of files; categories of data; size of the datasets in bytes. Uses Markdown for styling.

data_application string

data_issues string

A list of unresolved issues and quality concerns. Uses Markdown for styling.

introduction string

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

acquisition string

preparation string

Detailed description of material (product, model) and methods (provide references if possible) used to prepare the dataset. Uses Markdown for styling.

validation string

Detailed description of material (product, model) and methods (provide references if possible) used to validate the dataset for the purpose of data quality assessment. Uses Markdown for styling.

analysis string

Detailed description of material (product, model) and methods (provide references if possible) used to analyse the dataset for the purpose of data quality assessment. 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

Value of 1 means that the data of this dataset are publicly accessible.

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 is 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.

structure string

preparation string

It contains an unordered list of all changes made in the preparatory file described in the parent section according to Directory-006 (Dataset preparation). Uses Markdown for styling.

changes string

unresolved string

created_at string

The date and time the table was created.

updated_at string

The date and time the table was last updated.

id integer

Numeric identifier of the table.

descriptors string[]

An array of all descriptors, used to integrate this dataset. Field is 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.

Update dataset

requires authentication

Example request:

curl --request PUT \
    "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\": \"Est aperiam ut rerum commodi nostrum omnis enim ipsum.\",
    \"data_overview\": \"fitjlmzhov\",
    \"data_value\": \"vpgsbvd\",
    \"data_description\": \"ycaib\",
    \"data_application\": \"r\",
    \"data_issues\": \"gqnhxniwig\",
    \"introduction\": \"qrvivjcfkedawzfpze\",
    \"acquisition\": \"yojqwmxwboyljsqgg\",
    \"preparation\": \"uopfuosnztbkjzufoyfw\",
    \"validation\": \"kzcjoulncmjcbznmsomx\",
    \"analysis\": \"brnv\",
    \"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->put(
    $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' => 'Est aperiam ut rerum commodi nostrum omnis enim ipsum.',
            'data_overview' => 'fitjlmzhov',
            'data_value' => 'vpgsbvd',
            'data_description' => 'ycaib',
            'data_application' => 'r',
            'data_issues' => 'gqnhxniwig',
            'introduction' => 'qrvivjcfkedawzfpze',
            'acquisition' => 'yojqwmxwboyljsqgg',
            'preparation' => 'uopfuosnztbkjzufoyfw',
            'validation' => 'kzcjoulncmjcbznmsomx',
            'analysis' => 'brnv',
            '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": "Est aperiam ut rerum commodi nostrum omnis enim ipsum.",
    "data_overview": "fitjlmzhov",
    "data_value": "vpgsbvd",
    "data_description": "ycaib",
    "data_application": "r",
    "data_issues": "gqnhxniwig",
    "introduction": "qrvivjcfkedawzfpze",
    "acquisition": "yojqwmxwboyljsqgg",
    "preparation": "uopfuosnztbkjzufoyfw",
    "validation": "kzcjoulncmjcbznmsomx",
    "analysis": "brnv",
    "licence": "cc-by",
    "public": true,
    "published_at": "2023-07-04T11:24:58.000000Z"
};

fetch(url, {
    method: "PUT",
    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": "Est aperiam ut rerum commodi nostrum omnis enim ipsum.",
    "data_overview": "fitjlmzhov",
    "data_value": "vpgsbvd",
    "data_description": "ycaib",
    "data_application": "r",
    "data_issues": "gqnhxniwig",
    "introduction": "qrvivjcfkedawzfpze",
    "acquisition": "yojqwmxwboyljsqgg",
    "preparation": "uopfuosnztbkjzufoyfw",
    "validation": "kzcjoulncmjcbznmsomx",
    "analysis": "brnv",
    "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('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/datasets/{id}

PATCH 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

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

Abstract about the dataset. Uses Markdown for styling. Must not be greater than 150000 characters. Example: Est aperiam ut rerum commodi nostrum omnis enim ipsum.

data_overview string

data_value string

data_description string

data_application string

data_issues string

A list of unresolved issues and quality concerns. Uses Markdown for styling. Must not be greater than 150000 characters. Example: gqnhxniwig

introduction string

A longer description about the dataset. Uses Markdown for styling. Must not be greater than 150000 characters. Example: qrvivjcfkedawzfpze

acquisition string

preparation string

validation string

analysis string

licence string

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

Must be one of:

cc-by-4-0
cc-by-nc-4-0
cc-by-nc-nd-4-0
cc-by-nc-sa-3.0-igo
cc-by-nc-sa-4-0
cc-by-nd-4-0
cc-by-sa-4-0
cc0-1-0
eurostat
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

<aside class"warning">Only dataset without any tables can be deleted.

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 list of all tables of the supplied dataset.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/datasets/2/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/2/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/2/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/2/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

numeric identifier used to identify the dataset to display related parts of. Example: 2

Response

Response Fields

data object[]

A list of dataset tables available to the User.

* object

id integer

Numeric identifier of the table.

uid string

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

name string

The title of the table.

description string|null

Detailed description of the table.

featured_image string|null

URL to uploaded image representing this table.

type string

The type of this table.

licence string|null

The licence defined specifically for this table.

created_at string

The date and time it was created.

updated_at string

The date and time it was last updated.

Create table

requires authentication

Create and attach a new table to the supplied dataset.

Example request:

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

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

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

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

let body = {
    "name": "ISO 3166-1:2020",
    "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/2/parts'
payload = {
    "name": "ISO 3166-1:2020",
    "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

numeric identifier used to identify the dataset to display related parts of. Example: 2

Body Parameters

name string

The title of the table. Must not be greater than 30 characters. Example: ISO 3166-1:2020

type string

The type this Dataset Part represents. Use 'api' when uploading data via the API. Example: api

Must be one of:

api
file
files
spreadsheet

description string optional

Detailed description of the table. Accepts Markdown for styling. Must not be greater than 10000 characters.

structure string optional

preparation string optional

It contains an unordered list of all changes made in the preparatory file described in the parent section according to Directory-006 (Dataset preparation). Must not be greater than 50000 characters.

changes string optional

unresolved string optional

additional_information string optional

Any additional information required to acquire this table data. Must not be greater than 50000 characters.

Show table

requires authentication

Retrieve metadata for a single table within a dataset.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/parts/5" \
    --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/5';
$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/5"
);

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/5'
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: 39
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5",
                "auth": true
            },
            "update": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5",
                "method": "PUT/PATCH",
                "auth": true
            },
            "delete": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5",
                "method": "DELETE",
                "auth": true
            },
            "columns.index": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/columns",
                "auth": true
            },
            "columns.create": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/columns",
                "method": "POST",
                "auth": true
            },
            "data.index": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/data",
                "auth": true
            },
            "data.create": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/data",
                "method": "POST",
                "auth": true
            },
            "data.update": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/data",
                "method": "PUT/PATCH",
                "auth": true
            },
            "data.delete": {
                "href": "https://app.pollinatorhub.eu/api/v1/parts/5/data",
                "method": "DELETE",
                "auth": true
            }
        },
        "id": 5,
        "uid": "UNSDA25.NCMTR5.0",
        "name": "Un Comtrade Units",
        "description": "This table contains quantity units used in detailed UN Comtrade data, based on the standards of quantity recommended by the World Customs Organization (WCO).",
        "featured_image": null,
        "structure": null,
        "preparation": "None",
        "changes": "None",
        "unresolved": "None",
        "additional_information": null,
        "type": "file",
        "licence": "euph",
        "columns": [
            {
                "links": {
                    "self": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1882",
                        "auth": true
                    },
                    "update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1882",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1882",
                        "method": "DELETE",
                        "auth": true
                    }
                },
                "id": 1882,
                "name": "UnsdId",
                "description": null,
                "descriptor": {
                    "links": [],
                    "id": 849,
                    "uid": "0.0.NSDNT849",
                    "namespace": "unsd",
                    "name": "unsdUnitID",
                    "description": "Special units maintained by the [United Nations Statistics Division (UNSD)](https://app.pollinatorhub.eu/vocabulary/classes/7822)).",
                    "class": "[EUPH-code: 8037]",
                    "unit": null,
                    "created_at": "2025-02-12T17:44:44.000000Z",
                    "updated_at": "2025-02-14T11:53:11.000000Z"
                },
                "unit": null,
                "datatype": {
                    "links": [],
                    "label": "Integer",
                    "priority": 10
                },
                "order": 0,
                "created_at": "2024-01-26T18:44:26.000000Z",
                "updated_at": "2025-02-14T11:53:52.000000Z"
            },
            {
                "links": {
                    "self": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1883",
                        "auth": true
                    },
                    "update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1883",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1883",
                        "method": "DELETE",
                        "auth": true
                    }
                },
                "id": 1883,
                "name": "WCOAbbreviation",
                "description": null,
                "descriptor": {
                    "links": [],
                    "id": 315,
                    "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.",
                    "class": "[EUPH-code: 7322]",
                    "unit": null,
                    "created_at": null,
                    "updated_at": "2024-09-14T11:17:02.000000Z"
                },
                "unit": null,
                "datatype": {
                    "links": [],
                    "label": "String",
                    "priority": 100
                },
                "order": 0,
                "created_at": "2024-01-26T18:44:26.000000Z",
                "updated_at": "2025-02-14T11:53:52.000000Z"
            },
            {
                "links": {
                    "self": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1884",
                        "auth": true
                    },
                    "update": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1884",
                        "method": "PUT/PATCH",
                        "auth": true
                    },
                    "delete": {
                        "href": "https://app.pollinatorhub.eu/api/v1/columns/1884",
                        "method": "DELETE",
                        "auth": true
                    }
                },
                "id": 1884,
                "name": "Description",
                "description": null,
                "descriptor": {
                    "links": [],
                    "id": 315,
                    "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.",
                    "class": "[EUPH-code: 7322]",
                    "unit": null,
                    "created_at": null,
                    "updated_at": "2024-09-14T11:17:02.000000Z"
                },
                "unit": null,
                "datatype": {
                    "links": [],
                    "label": "String",
                    "priority": 100
                },
                "order": 0,
                "created_at": "2024-01-26T18:44:26.000000Z",
                "updated_at": "2025-02-14T11:53:52.000000Z"
            }
        ],
        "data_files": [
            {
                "links": [],
                "id": 886,
                "name": "euph_000025_unsd_table_uncomtradeunits.csv",
                "description": null,
                "status": "analyzed",
                "type": "csv",
                "mimetype": "text/csv",
                "file_size": 483,
                "download_count": 0,
                "created_at": "2025-02-14T11:32:07.000000Z",
                "updated_at": "2025-02-14T11:35:06.000000Z"
            }
        ],
        "supplemental_files": [],
        "created_at": "2023-02-04T14:56:12.000000Z",
        "updated_at": "2025-04-18T09:44:16.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 metadata associated with the requested dataset table.

id integer

Numeric identifier of the table.

uid string

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

name string

The title of the table.

description string|null

Detailed description of the table.

featured_image string|null

URL to uploaded image representing this table.

structure string|null

preparation string|null

It contains an unordered list of all changes made in the preparatory file described in the parent section according to Directory-006 (Dataset preparation).

changes string|null

It contains an unordered list of all changes made in the data after integration of the file described in the parent section into the EUPH according to Directory-006 (Dataset preparation).

unresolved string|null

It contains an unordered list of all unresolved issues in the file of the parent section requiring intervention by the data provider according to Directory-007 (Data profiling).

type string

The type of this table.

additional_information string|null

Any additional information required to acquire this table data.

licence string|null

The licence defined specifically for this table.

columns string[]

A list of associated columns with this table.

* object

id integer

Numeric identifier of the column.

name string

The title of the column.

description string|null

Detailed description of the column.

descriptor string[]

The descriptor used to internally represent the data.

id integer

Numeric identifier of the descriptor.

uid string

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

namespace string|null

The namespace this descriptor conforms to.

name string

The title of the descriptor.

description string|null

Detailed description of the descriptor.

class string|null

The class this descriptor is described by.

unit

array|null The unit the data of this descriptor is saved in.

datatype string[]

The datatype this column saves data in.

label string

The label of the datatype.

priority integer

The priority ranking of this datatype.

order integer

The order of this column, that it appears in the table.

created_at string

The date and time it was created.

updated_at string

The date and time it was last updated.

data_files string[]

A list of uploaded data files.

* object

id integer

Numeric identifier of the uploaded file.

name string

The original filename.

description string|null

status string

The internal status of this file.

type string

Identified type of this file.

mimetype string

Identified mimetype of this file.

file_size integer

The filesize in bytes.

download_count

intNumber of times this file was downloaded.

created_at string

The date and time it was created.

updated_at string

The date and time it was last updated.

supplemental_files string[]

A list of uploaded data files.

* object

id integer

Numeric identifier of the uploaded file.

name string

The original filename.

description string|null

status string

The internal status of this file.

type string

Identified type of this file.

mimetype

stringIdentified mimetype of this file.

file_size

intThe filesize in bytes.

download_count integer

Number of times this file was downloaded.

created_at string

The date and time it was created.

updated_at string

The date and time it was last updated.

created_at string

The date and time it was created.

updated_at string

The date and time it was last updated.

Update table

requires authentication

Update table metadata with new values.

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 table 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 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 ,spreadsheet ,survey. Example: api

Must be one of:

api
file
files
spreadsheet

Delete table.

requires authentication

Delete a single table. <aside class"warning">Only table with no uploaded data can be deleted.

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 (202):

{}

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.

Columns

This route will allow modifications to the meta-data for individual columns of a dataset. It includes basic information like name, description and descriptor information. It is owned by one or more entities. It is identified by numeric ID which is created during creation procedure.

List columns

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/parts/1/columns?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/parts/1/columns';
$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/parts/1/columns"
);

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/parts/1/columns'
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: 38
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/1",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/1",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/1",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 1,
            "name": "CountryId",
            "description": null,
            "descriptor": {
                "links": [],
                "id": 344,
                "uid": "0.0.RCRDD344",
                "namespace": "pms",
                "name": "recordID",
                "description": "Unique sequence of integers associated with a record within a certain table.",
                "class": "[EUPH-code: 3331]",
                "unit": null,
                "created_at": "2023-11-26T12:08:55.000000Z",
                "updated_at": "2025-02-06T15:51:38.000000Z"
            },
            "unit": null,
            "datatype": null,
            "order": 0,
            "created_at": "2023-09-01T08:53:37.000000Z",
            "updated_at": "2025-02-12T13:19:21.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/2",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/2",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/2",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 2,
            "name": "NumericCode",
            "description": null,
            "descriptor": {
                "links": [],
                "id": 519,
                "uid": "0.0.MAREA519",
                "namespace": "unsd",
                "name": "m49Area",
                "description": "Name of the countries or areas or geographic regions in the [M49 standard](https://app.pollinatorhub.eu/vocabulary/classes/7292) used for statistical processing purposes by the [Statistics Division of the United Nations Secretariat](https://unstats.un.org).",
                "class": "[EUPH-code: 7441]",
                "unit": null,
                "created_at": "2024-11-22T15:54:40.000000Z",
                "updated_at": "2025-02-06T12:33:33.000000Z"
            },
            "unit": null,
            "datatype": null,
            "order": 0,
            "created_at": "2023-09-01T08:53:37.000000Z",
            "updated_at": "2025-02-12T13:12:03.000000Z"
        },
        {
            "links": {
                "self": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/3",
                    "auth": true
                },
                "update": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/3",
                    "method": "PUT/PATCH",
                    "auth": true
                },
                "delete": {
                    "href": "https://app.pollinatorhub.eu/api/v1/columns/3",
                    "method": "DELETE",
                    "auth": true
                }
            },
            "id": 3,
            "name": "FullName",
            "description": "Full name of the country, as recorded in [UNTERM](https://unterm.un.org).",
            "descriptor": {
                "links": [],
                "id": 315,
                "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.",
                "class": "[EUPH-code: 7322]",
                "unit": null,
                "created_at": null,
                "updated_at": "2024-09-14T11:17:02.000000Z"
            },
            "unit": null,
            "datatype": null,
            "order": 0,
            "created_at": "2023-09-01T08:53:37.000000Z",
            "updated_at": "2025-02-12T13:12:03.000000Z"
        }
    ],
    "first_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=1",
    "from": 1,
    "last_page": 5,
    "last_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=5",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/columns?page=2",
    "path": "https://app.pollinatorhub.eu/api/v1/parts/1/columns",
    "per_page": 3,
    "prev_page_url": null,
    "to": 3,
    "total": 15
}

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}/columns

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 part. Example: 1

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.

* object

id integer

Numeric identifier of the dataset.

name string

The actual name of the dataset.

long_name string

The long version of the name of the dataset.

uid string

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

description string

Dataset abstract. Uses Markdown for styling.

featured_image string|null

URL to uploaded image representing this 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.

Create column

requires authentication

Example request:

curl --request POST \
    "https://app.pollinatorhub.eu/api/v1/parts/1/columns" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Hive scale weight\",
    \"descriptor\": \"0.0.LPHCN4\",
    \"datatype\": \"String, Integer, Decimal, Date, Time, DateTime, Boolean\",
    \"order\": 1
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/parts/1/columns';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Hive scale weight',
            'descriptor' => '0.0.LPHCN4',
            'datatype' => 'String, Integer, Decimal, Date, Time, DateTime, Boolean',
            'order' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

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

let body = {
    "name": "Hive scale weight",
    "descriptor": "0.0.LPHCN4",
    "datatype": "String, Integer, Decimal, Date, Time, DateTime, Boolean",
    "order": 1
};

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/columns'
payload = {
    "name": "Hive scale weight",
    "descriptor": "0.0.LPHCN4",
    "datatype": "String, Integer, Decimal, Date, Time, DateTime, Boolean",
    "order": 1
}
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/parts/{part_id}/columns

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 part. Example: 1

Body Parameters

name string

The title of the column. Must not be greater than 30 characters. Example: Hive scale weight

description string optional

Detailed description of the column. Accepts Markdown for styling. Must not be greater than 10000 characters.

descriptor string

The descriptor UID, used to represent the type of data within the column. Consult the documentation and vocabulary for a list of descriptors, available within the platform. The uid of an existing record in the descriptors table. Example: 0.0.LPHCN4

datatype string optional

The datatype of the data within the column (case sensitive). Can be left blank to use the default Descriptor datatype. Consult the documentation and vocabulary for a list of available datatypes for each individual Descriptor. Example: String, Integer, Decimal, Date, Time, DateTime, Boolean

Must be one of:

Boolean
Coordinates
Date
DateTime
Decimal
Integer
String
Time

order integer optional

Integer representing the column order number within the dataset. Used to organize tables when visualizing or exporting data. Example: 1

Show column

requires authentication

Display the specified dataset table column based on provided numeric identifier.

Example request:

curl --request GET \
    --get "https://app.pollinatorhub.eu/api/v1/columns/4" \
    --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/columns/4';
$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/columns/4"
);

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/columns/4'
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: 37
access-control-allow-origin: *


{
    "data": {
        "links": {
            "self": {
                "href": "https://app.pollinatorhub.eu/api/v1/columns/4",
                "auth": true
            },
            "update": {
                "href": "https://app.pollinatorhub.eu/api/v1/columns/4",
                "method": "PUT/PATCH",
                "auth": true
            },
            "delete": {
                "href": "https://app.pollinatorhub.eu/api/v1/columns/4",
                "method": "DELETE",
                "auth": true
            }
        },
        "id": 4,
        "name": "ShortName",
        "description": null,
        "descriptor": {
            "links": [],
            "id": 3,
            "uid": "0.0.SHRTC3",
            "namespace": "iso-3166",
            "name": "shortUppercaseNameOfCountry",
            "description": "> [...] Short form of the country name [in capital letters], distinctive word first. [...] In [language of the ISO 3166 standard](https://app.pollinatorhub.eu/vocabulary/classes/7930). [...] This item might be inverted, allowing the distinctive word to appear first, so that items can be easily found in an alphabetical list. See [Annex F]https://www.iso.org/obp/ui/en/#iso:std:iso:3166:-1:ed-4:v1:en:sec:F), principles [F.2](https://www.iso.org/obp/ui/en/#iso:std:iso:3166:-1:ed-4:v1:en:sec:F.2).",
            "class": "[EUPH-code: 7929]",
            "unit": null,
            "created_at": "2022-11-19T09:03:29.000000Z",
            "updated_at": "2025-02-12T11:56:33.000000Z"
        },
        "unit": null,
        "datatype": null,
        "order": 0,
        "created_at": "2023-09-01T08:53:37.000000Z",
        "updated_at": "2025-02-12T13:12:03.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 metadata associated with the requested dataset.

id integer

Numeric identifier of the dataset.

uid string

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

name string

The actual name of the dataset.

created_at string

The date and time the dataset was created.

updated_at string

The date and time the dataset was last updated.

Update column

requires authentication

Example request:

curl --request PUT \
    "https://app.pollinatorhub.eu/api/v1/columns/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Hive scale weight\",
    \"descriptor\": \"0.0.LPHCN4\",
    \"datatype\": \"String, Integer, Decimal, Date, Time, DateTime, Boolean\",
    \"order\": 1
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.pollinatorhub.eu/api/v1/columns/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Hive scale weight',
            'descriptor' => '0.0.LPHCN4',
            'datatype' => 'String, Integer, Decimal, Date, Time, DateTime, Boolean',
            'order' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

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

let body = {
    "name": "Hive scale weight",
    "descriptor": "0.0.LPHCN4",
    "datatype": "String, Integer, Decimal, Date, Time, DateTime, Boolean",
    "order": 1
};

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

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/columns/1'
payload = {
    "name": "Hive scale weight",
    "descriptor": "0.0.LPHCN4",
    "datatype": "String, Integer, Decimal, Date, Time, DateTime, Boolean",
    "order": 1
}
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/columns/{id}

PATCH api/v1/columns/{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 column. Example: 1

Body Parameters

name string

The title of the column. Must not be greater than 30 characters. Example: Hive scale weight

description string optional

Detailed description of the column. Accepts Markdown for styling. Must not be greater than 10000 characters.

descriptor string

datatype string optional

Must be one of:

Boolean
Coordinates
Date
DateTime
Decimal
Integer
String
Time

order integer optional

Integer representing the column order number within the dataset. Used to organize tables when visualizing or exporting data. Example: 1

Delete column

requires authentication

Example request:

curl --request DELETE \
    "https://app.pollinatorhub.eu/api/v1/columns/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/columns/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/columns/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/columns/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.

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&query%5Bdescriptor_uid%5D=query%5B0.0.TEXTA315%5D%3Dexample_value" \
    --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',
            'query[descriptor_uid]' => 'query[0.0.TEXTA315]=example_value',
        ],
    ]
);
$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",
    "query[descriptor_uid]": "query[0.0.TEXTA315]=example_value",
};
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',
  'query[descriptor_uid]': 'query[0.0.TEXTA315]=example_value',
}
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: 36
access-control-allow-origin: *


{
    "current_page": 1,
    "data": [
        {
            "links": [],
            "id": 1,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "0.0.RCRDD344",
                    "column": "CountryId",
                    "column_id": 1,
                    "value": "1",
                    "unit": null
                },
                {
                    "descriptor": "0.0.MAREA519",
                    "column": "NumericCode",
                    "column_id": 2,
                    "value": "10",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC3",
                    "column": "ShortName",
                    "column_id": 4,
                    "value": "ANTARCTICA",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC10",
                    "column": "ShortNameLcEn",
                    "column_id": 5,
                    "value": "Antarctica",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "Alpha2Code",
                    "column_id": 6,
                    "value": "AQ",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN5",
                    "column": "Alpha3Code",
                    "column_id": 7,
                    "value": "ATA",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "Status",
                    "column_id": 11,
                    "value": "Officially assigned",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "AnnotationP1En",
                    "column_id": 13,
                    "value": "Territories south of 60° south latitude.",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "AnnotationP2En",
                    "column_id": 14,
                    "value": "No subdivisions relevant for this standard.",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "AnnotationP3En",
                    "column_id": 15,
                    "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
                }
            ]
        },
        {
            "links": [],
            "id": 2,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "0.0.RCRDD344",
                    "column": "CountryId",
                    "column_id": 1,
                    "value": "2",
                    "unit": null
                },
                {
                    "descriptor": "0.0.MAREA519",
                    "column": "NumericCode",
                    "column_id": 2,
                    "value": "100",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "FullName",
                    "column_id": 3,
                    "value": "the Republic of Bulgaria",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC3",
                    "column": "ShortName",
                    "column_id": 4,
                    "value": "BULGARIA",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC10",
                    "column": "ShortNameLcEn",
                    "column_id": 5,
                    "value": "Bulgaria",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "Alpha2Code",
                    "column_id": 6,
                    "value": "BG",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN5",
                    "column": "Alpha3Code",
                    "column_id": 7,
                    "value": "BGR",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "Status",
                    "column_id": 11,
                    "value": "Officially assigned",
                    "unit": null
                }
            ]
        },
        {
            "links": [],
            "id": 3,
            "timestamp": "2020",
            "data": [
                {
                    "descriptor": "0.0.RCRDD344",
                    "column": "CountryId",
                    "column_id": 1,
                    "value": "3",
                    "unit": null
                },
                {
                    "descriptor": "0.0.MAREA519",
                    "column": "NumericCode",
                    "column_id": 2,
                    "value": "104",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "FullName",
                    "column_id": 3,
                    "value": "the Republic of the Union of Myanmar",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC3",
                    "column": "ShortName",
                    "column_id": 4,
                    "value": "MYANMAR",
                    "unit": null
                },
                {
                    "descriptor": "0.0.SHRTC10",
                    "column": "ShortNameLcEn",
                    "column_id": 5,
                    "value": "Myanmar",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN4",
                    "column": "Alpha2Code",
                    "column_id": 6,
                    "value": "MM",
                    "unit": null
                },
                {
                    "descriptor": "0.0.LPHCN5",
                    "column": "Alpha3Code",
                    "column_id": 7,
                    "value": "MMR",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "Status",
                    "column_id": 11,
                    "value": "Officially assigned",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "AnnotationP2En",
                    "column_id": 14,
                    "value": "Remark: the forms used in the list are English-language forms provided by Myanmar.",
                    "unit": null
                },
                {
                    "descriptor": "0.0.TEXTA315",
                    "column": "AnnotationP3En",
                    "column_id": 15,
                    "value": "Name changed from former Burma (BU, BUR, 104) to Myanmar (MM MMR, 104). See code element BUMM.",
                    "unit": null
                }
            ]
        }
    ],
    "first_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=1",
    "from": 1,
    "last_page": 97,
    "last_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=97",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=4",
            "label": "4",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=5",
            "label": "5",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=6",
            "label": "6",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=7",
            "label": "7",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=8",
            "label": "8",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=9",
            "label": "9",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=10",
            "label": "10",
            "active": false
        },
        {
            "url": null,
            "label": "...",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=96",
            "label": "96",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=97",
            "label": "97",
            "active": false
        },
        {
            "url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=2",
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": "https://app.pollinatorhub.eu/api/v1/parts/1/data?page=2",
    "path": "https://app.pollinatorhub.eu/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

query[descriptor_uid] string optional

Filter by descriptor UID with specific value. Use descriptor UID as key and desired value as parameter value. Example: query[0.0.TEXTA315]=example_value

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.*

column string|null

The name of the column, the value was imported from. Can be null when streamed via API.

column_id int|null

The internal id of the column. Can be null when streamed via API.

value

The value of the datum.

unit

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

Store Data

requires authentication

Store a set of records within the 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 (201):

{}

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.SHRTC3
0.0.LPHCN4
0.0.LPHCN5
See descriptor reference guide for full list.

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
Da
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
thousand spores per animal
million spores per animal
billion spores per animal

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?query%5Bdescriptor_uid%5D=query%5B0.0.TEXTA315%5D%3Dexample_value" \
    --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',
        ],
        'query' => [
            'query[descriptor_uid]' => 'query[0.0.TEXTA315]=example_value',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

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

const params = {
    "query[descriptor_uid]": "query[0.0.TEXTA315]=example_value",
};
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: "DELETE",
    headers,
}).then(response => response.json());

import requests
import json

url = 'https://app.pollinatorhub.eu/api/v1/parts/1/data'
params = {
  'query[descriptor_uid]': 'query[0.0.TEXTA315]=example_value',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, params=params)
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

Query Parameters

query[descriptor_uid] string optional

Filter by descriptor UID with specific value. Use descriptor UID as key and desired value as parameter value. Example: query[0.0.TEXTA315]=example_value

Body Parameters

records object optional

Must not have more than 500 items.

Response

Response Fields

deleted_records integer

Number of records deleted from the database.

Update Data

requires authentication

Update a set of records defined by the query filter for data within the provided Dataset Part.

Example request:

curl --request PATCH \
    "https://app.pollinatorhub.eu/api/v1/parts/1/data?query%5Bdescriptor_uid%5D=query%5B0.0.TEXTA315%5D%3Dexample_value" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"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->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'query[descriptor_uid]' => 'query[0.0.TEXTA315]=example_value',
        ],
        'json' => [
            '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 params = {
    "query[descriptor_uid]": "query[0.0.TEXTA315]=example_value",
};
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",
};

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

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

import requests
import json

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

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

Example response (201):

{}

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/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

query[descriptor_uid] string optional

Filter by descriptor UID with specific value. Use descriptor UID as key and desired value as parameter value. Example: query[0.0.TEXTA315]=example_value

Body Parameters

timestamp string optional

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

data object[] optional

A list of columns to insert.

descriptor string

UID of the descriptor. Example: 0.0.NTSCD55

Must be one of:

0.0.SHRTC3
0.0.LPHCN4
0.0.LPHCN5
See descriptor reference guide for full list.

value string

The value of the column. 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
Da
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
thousand spores per animal
million spores per animal
billion spores per animal

Response

Response Fields

updated_records integer

Number of records updated in the database.