API Reference

API path format

Every API user gets provided their own unique AccountID and Endpoint ID

Sample:

https://api.getdatapipe.com/v1/data/37815e65-379b-4a23-b897-bfe5a1a64a61/aec10fde-7d6c-4e62-b55b-200bf817bcf8

Where:

  • https://api.getdatapipe.com

    • main datapipe API

  • /v1

    • Current version of the API

  • /data

    • Data path

  • /37815e65-379b-4a23-b897-bfe5a1a64a61

    • Account ID

  • /aec10fde-7d6c-4e62-b55b-200bf817bcf8

    • Endpoint ID

get
Get account's data

https://api.getdatapipe.com/v1/data/:accountId/:endpointId
Request
Response
Request
Path Parameters
accountId
required
string
Account ID
endpointId
required
string
Endpoint / Data ID
Headers
user
required
string
Account's email
x-api-key
required
string
API Authentication Key
Response
200: OK
{
"data": [
{ "id": 1, "country": "Australia" },
{ "id": 1, "country": "Singapore" }
]
}

post
File upload

https://api.getdatapipe.com/v1/data/:accountId/:endpointId/file
Request
Response
Request
Path Parameters
accountId
required
string
endpointId
required
string
Headers
user
required
string
Account's email
x-api-key
optional
string
API authentication key
Form Data Parameters
file
required
object
File with the following format: CSV, XML, XLSX, JSON
Response
200: OK
{
"message": "OK"
}

post
Transform your Google Sheet

https://api.getdatapipe.com/v1/:accountId/:endpointId/sheet
Request
Response
Request
Path Parameters
accountId
required
string
Account ID
endpointId
required
string
Endpoint ID
Headers
user
required
string
Account's email
x-api-key
required
string
API authentication key
Body Parameters
spreadsheetId
required
string
Google Spread Sheet ID
sheetId
optional
string
Google Sheet ID. If not sheetId provided, datapipe will use the first sheet - index zero - as the default source data
Response
200: OK

post
Transform a Webhook data

https://api.getdatapipe.com/v1/:accountId/:endpointId/webhook
Request
Response
Request
Path Parameters
accountId
required
string
Account ID
endpointId
required
string
Endpoint ID
Headers
x-api-key
optional
string
API authentication key
user
optional
string
Account's email
Response
200: OK