Get Chart - Synap API (Beta)

Request

Query Params

type

enum<string>

required

Allowed values:

portal-activityengagementsl-overview

user

string

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (ChartJs) {4}]

required

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

ChartJs

Example:

ChartJs

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

id

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

links

object

optional

self

string

optional

This field should be a valid URL.

Example:

https://some-url.com/path?query=true

meta

object

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "ChartJs",
            "attributes": {
                "type": "portal-activity",
                "chart": {
                    "type": "line",
                    "options": {},
                    "data": {
                        "labels": [
                            "string"
                        ],
                        "datasets": [
                            {}
                        ]
                    }
                }
            },
            "relationships": {}
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "links": {
        "self": "https://some-url.com/path?query=true"
    },
    "meta": {}
}

🟠400Bad Request

🟠401Unauthorized