SEEN API 2.0 - List Data – SEEN Documentation

List available data items in your workspace.

Endpoint

https://next.seen.io/v1/workspaces/{Workspace_ID}/data

You can view your workspace ID in your SEEN Platform account URL, e.g. if you are viewing the Dashboard, the URL is https://be.seen.io/{Workspace_ID}/dashboard

Request Method

GET

Request Headers

Authorization

This header is common to all requests to our API. Please see the “Authorization” section for more details.

Content-Type

Content-Type should be configured as application/json

Path Parameters

The List Data endpoint supports the following path parameters:

Query - String

limit

Limit the amount of data items returned - Integer

offset

Exclude first N items from the data items returned - Integer

Example Requests

List all Data

https://next.seen.io/v1/workspaces/{Workspace_ID}/data

List all data that match a query

https://next.seen.io/v1/workspaces/{Workspace_ID}/data?q=first_name:Daniel&country:Norway

Remember to match the query fields with your Workspace Properties

Limit the amount of data listed

https://next.seen.io/v1/workspaces/{Workspace_ID}/data?limit=100

Offset the amount of data listed

https://next.seen.io/v1/workspaces/{Workspace_ID}/data?offset=100

Rate Limit

SEEN API accepts up to 100 requests per 10 seconds.

Responses

Upon posting the request, you will receive one of the following responses from our API:

200

Upon a successful request, you will receive a 200 OK response.

Example response body:

{
    "count": 1,
    "data": [
        {
            "id": "...",
            "journeyOutputs": [
                {
                    "id": "...",
                    "motions": [
                        {
                            "emailThumbnail": "https://motions.seen.io/2b183354-3aa3-4eda-9416-045b3178fe6e/5b0461194f3092c033a6be518229e93b9b85e2db73c4e166e87c397ba9570f6e/email_thumbnail.jpg",
                            "id": "...",
                            "thumbnail": "https://motions.seen.io/2b183354-3aa3-4eda-9416-045b3178fe6e/5b0461194f3092c033a6be518229e93b9b85e2db73c4e166e87c397ba9570f6e/thumbnail.jpg"
                        }
                    ],
                    "players": [
                        {
                            "id": "...",
                            "link": "https://player.seen.io/v/eHmnkM2wqAWcgkQQmxPP"
                        }
                    ],
                    "webhook": null
                }
            ],
            "values": {
                "country": "Norway",
                "first_name": "Daniel"
            }
        }
    ],
    "elementsPerPage": 20
}

400

Upon a bad request, you will receive a 400 Bad Request response.

Example response body:

{
  "code": "ErrInvalidParameter",
  "message": "limit must be a positive number"
}

401

Upon an unauthorized request, you will receive a 401 Unautorized response.

Example response body:

{
"code": "ErrUnauthenticated",
"message": "api key invalid"
}

429

Upon exceeding the rate limit, you will receive a 429 Too Many Requests response.

Example response body:

<!doctype html><meta charset="utf-8"><meta name=viewport content="width=device-width, initial-scale=1"><title>429</title>429 Too Many Requests

500

Upon a client error, you will receive a 500 Internal Server Error response.

Example response body:

{
  "code": "ErrClient",
  "message": "service unavailable"
}