Skip to main content

Consume Data

Overview​

Who is this guide for?

Role: Data Consumer

Goal: You want to find a Dataset and retrieve its data payload via the API.

Required Permissions: read Dataset

What you will achieve​

After completing this guide, you will have:

  • Found a Dataset
  • Accessed its API
  • Retrieved data payload

Before you start​

Make sure that:

  • the Dataset is in status Available
  • you have access permissions
  • or Open Data is enabled

Understand data consumption​

In CIVITAS/CORE, data is accessed through the API of a Dataset. This means:

  • a Dataset provides an API endpoint
  • the API returns the data payload
  • access is controlled through Groups and Roles or Open Data

Step-by-step guide​

Step 1: Find a Dataset​

  1. Go to Datasets
  2. Browse the list or search for the Dataset you want to access
  3. Open the Dataset

Screenshot: Dataset list view

note

You can only open Datasets that you have access to.

Step 2: Copy the API URL​

  1. In the Dataset detail view, go to the 2nd section Data flow
  2. Locate the API URL

Screenshot: Data Flow section with API URL highlighted

  1. Copy the URL
Understand the API URL

The API URL shown in the Dataset detail view is a relative path (e.g. api/...). To use it, you need to prepend your Platform domain.

Example: https://<your-platform-domain>/api/…

The full URL is the access point for the Dataset payload.

Step 3: Use the API URL​

  1. Paste the full API URL into the API tool of your choice
  2. Make sure you are authenticated for the request
  3. Use it to retrieve and consume the data payload

Optional: Access Open Data directly​

If a Dataset is released as Open Data, you do not need access permissions in CIVITAS/CORE. You only need the API URL. If someone shares the URL with you, you can use it directly to access the payload data.

Outcome​

You have accessed the API of a Dataset and retrieved its payload data.

  • If the Dataset is protected, access depends on your permissions
  • If the Dataset is released as Open Data, the API can be used without authentication