# Command Center Reports API Docs

### Format

All calls are returned in **JSON**.

### Status Codes

- **200** Successful GET, PUT, and PATCH.
- **201** Successful POST.
- **204** Successfull POST without response body.
- **401** Unauthenticated.
- **403** Forbidden.

## Group Class Report
### GET /group-class-report/

#### Example request

$ curl -X GET \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTM0OTI1MTQwLCJleHAiOjE1MzUwMTE1NDB9.MIcWFBzAr5WVhbaSa1kd1_hmEZsepo8fXqotqvAerKI"  \
"http://www.mocky.io/v2/to_be_updated"

Make sure that the logged in user's group has access to this endpoint.
#### Response

{
	"count": 2,
	"next": null,
	"previous": null,
	"results": [{
            "learner_first_name": "This",
            "learner_last_name": "Learner",
            "learner_email": "[e-mail]",
            "learner_group_name": "Learner Group",
            "class_start_time": "2020-05-06 15:00:00",
            "attended": true,
            "length_of_class": 30,
            "canceled_at": null,
            "joined_at": "2020-05-06 15:01:00",
            "level": "High Beginner",
            "class_name": "Awesome Class",
            "lesson": {
                "title": "Talk in english",
                "url": "https://app.voxy.com/activities/lesson/by-resource/5e8249cdd38ff38371eed237/"
            },
            "teacher_name": "Best Teacher",
        },
        {
            "learner_first_name": "That",
            "learner_last_name": "Learner",
            "learner_email": "[e-mail]",
            "learner_group_name": "Cool Group",
            "class_start_time": "2020-07-07 10:00:00",
            "attended": false,
            "length_of_class": 60,
            "canceled_at": "2020-07-06 10:00:00",
            "joined_at": null,
            "level": "High Beginner",
            "class_name": "Best Class Ever",
            "lesson": {
                "title": "Talk in english",
                "url": "https://app.voxy.com/activities/lesson/by-resource/5e8249cdd38ff38371eed237/"
            },
            "teacher_name": "Mr. Teacher",
        }]
}

## VPA Reports

### GET /api/v0/vpa-report/?limit=15&offset=0&organization_id=14

#### Example request

$ curl -X GET \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTM0OTI1MTQwLCJleHAiOjE1MzUwMTE1NDB9.MIcWFBzAr5WVhbaSa1kd1_hmEZsepo8fXqotqvAerKI"  \
"https://run.mocky.io/v3/0b86a334-07b3-4cb5-9c9e-f7520193f04a"

Make sure that the logged in user's group has access to this endpoint.
#### Response

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "completed_at": "2020-11-09 19:25:02",
            "overall_score": 530,
            "overall_level": "Intermediate",
            "speaking_level": null,
            "speaking_score": null,
            "reading_level": "Low Intermediate",
            "reading_score": 150,
            "listening_level": "Low Intermediate",
            "listening_score": 110,
            "grammar_level": "Intermediate",
            "grammar_score": 270,
            "total_time_spent_on_test": 0.23333333333333334,
            "vpa_id": "5",
            "first_name": "Daniel",
            "last_name": "Smith",
            "email": "[e-mail]",
            "group_name": "Default",
            "score_total": 530,
            "started_at": "2020-11-09 19:24:05"
        }
    ]
}

## Activity User History
### GET /api/v0/user-activities-history/?limit=15&offset=0

#### Example request

$ curl -X GET \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNTM0OTI1MTQwLCJleHAiOjE1MzUwMTE1NDB9.MIcWFBzAr5WVhbaSa1kd1_hmEZsepo8fXqotqvAerKI"  \
"https://run.mocky.io/v3/bd315142-c501-46b9-bfda-bf9d7fdbc6d7"

#### Response

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "date_completed": "2020-11-09",
            "time_completed": "19:24:05",
            "lesson": "Space Ship",
            "activity": "Nasa",
            "score": "50%"
        },
        {
            "date_completed": "2020-09-19",
            "time_completed": "20:24:05",
            "lesson": "Meeting Someone New",
            "activity": "Hear Me Out",
            "score": "100%"
        },
        {
            "date_completed": "2020-12-19",
            "time_completed": "20:24:05",
            "lesson": "Humanizing Diversity and Inclusion",
            "activity": "Watch and Learn",
            "score": "100%"
        },
    ]
}