Viewer Group

Viewer Group Schema

• id: Unique id for every file

• name: name of the file

• created_at: File creation timestamp

Get All Viewer Group

POST https://api.gmetri.com/sdk/viewer_group/getAll

Get All viewer group of the organization

Headers

Name	Type	Description
Authorization*	String	Token <apiToken>

Request Body

Name	Type	Description
orgSlug*	String

200: OK

{
    "status": {
        "success": true
    },
    "data": {
        "orgViewerGroups": [
            {
                "id": 7,
                "name": "Group (1)",
                "created_at": "2022-09-05T08:06:56.375671"
            },
            {
                "id": 8,
                "name": "SAML",
                "created_at": "2022-09-08T10:30:47.483744"
            }
        ],
        "globalViewerGroups": [
            {
                "id": 1,
                "name": "Social",
                "created_at": "2022-09-05T06:37:22.024655"
            },
            {
                "id": 3,
                "name": "Public",
                "created_at": "2022-09-05T06:37:22.024655"
            },
            {
                "id": 4,
                "name": "SCORM",
                "created_at": "2022-09-05T06:37:22.428923"
            },
            {
                "id": 5,
                "name": "Public with History (beta)",
                "created_at": "2022-09-05T06:37:22.592825"
            },
            {
                "id": 2,
                "name": "Editor",
                "created_at": "2022-09-05T06:37:22.024655"
            },
            {
                "id": 6,
                "name": "Load From Another Experience",
                "created_at": "2022-09-05T06:37:24.890609"
            }
        ]
    }
}

Get Viewer Group

POST https://api.gmetri.com/sdk/viewer_group/get

Get viewer group of the organization by viewer group id

Headers

Name	Type	Description
Authorization*	String	Token <apiToken>

Request Body

Name	Type	Description
orgSlug*	String
viewerGroupId*	String	Unique identifier of the viewer group

200: OK Success

{
    "status": {
        "success": true
    },
    "data": {
        "id": 3,
        "name": "Public",
        "created_at": "2022-09-05T06:37:22.024655"
    }
} 

200: OK No Viewer Group Found

{
    "status": {
        "success": false,
        "errorMessage": "No viewer group found"
    }
}