> For the complete documentation index, see [llms.txt](https://cgps.gitbook.io/data-flo/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cgps.gitbook.io/data-flo/reference-guide/import-from-epicollect-project.md).

# import-from-epicollect-project

## Description

<mark style="color:purple;">`import-from-epicollect-project`</mark> *adaptor retrieves data collected in an Epicollect project where each row is a collected entry and each column is a data field.*

## Inputs

**`url`**\
Type: `text`\
Required: Yes\
The URL of the Epicollect5 project to be imported (e.g., <https://five.epicollect.net/project/ec5-demo-project>).

**`client id`**\
Type: `text`\
Required: No\
The [Epicollect5 Client ID](https://docs.epicollect.net/developers/apps) to access private projects. Not required for public projects.

**`client secret`**\
Type: `text`\
Required: No\
The [Epicollect5 Client Secret](https://docs.epicollect.net/developers/apps) to access private projects. Not required for public projects.

**`map index`**\
Type: `text`\
Required: No\
The [index of the mapping](< https://docs.epicollect.net/web-application/mapping-data>) to use when importing the data. If unspecified, the default mapping is used.

## Outputs

**`data`**\
Type: `datatable`\
A datatable containing the project entries.

## Examples

### Example 1: Default behaviour.

#### Inputs:

`url:` <https://five.epicollect.net/project/mr-demo>

`client id:` *null (empty)*

`client secret:` *null (empty)*

`map index:` *null (empty)*

#### Outputs:

`data`:

| title                                | created\_at              | sample   | latitude    | longitude    |
| ------------------------------------ | ------------------------ | -------- | ----------- | ------------ |
| ab13ca80-0363-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample A | 4.642276772 | -8.17536836  |
| ce24ca61-1463-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample B | 5.063345736 | -9.051186684 |
| ah56ga85-2563-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample C | 5.063345736 | -9.051186684 |

-> Imported data from a public Epicollect project into Data-flo.

### Example 2: Import a private Epicollect project.

#### Inputs:

`url:` <https://five.epicollect.net/project/private-demo>

`client id:` 123456

`client secret:` 7891011

`map index:` *null (empty)*

#### Outputs:

`data`:

| title                                | created\_at              | sample   | latitude    | longitude    |
| ------------------------------------ | ------------------------ | -------- | ----------- | ------------ |
| ab13ca80-0363-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample A | 4.642276772 | -8.17536836  |
| ce24ca61-1463-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample B | 5.063345736 | -9.051186684 |
| ah56ga85-2563-11ed-8cfe-d7b5b6bd3730 | 2022-07-14T10:56:52.521Z | Sample C | 5.063345736 | -9.051186684 |

-> Imported data from a private Epicollect project into Data-flo.