Monthly Losses Graphs

Monthly Losses Graphs Documentation

Monthly Losses Graph [GET]

Monthly Losses Graph [GET]

Request

Endpoint

GET /api/v2/reports/monthly_losses_graphs/e22029db-34d1-4980-9840-e4538f25347e
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "reports::monthlylossesgraph",
    "type": "reports_monthly_losses_graphs",
    "attributes": {
      "account_list": {
        "id": "e22029db-34d1-4980-9840-e4538f25347e",
        "name": "Derek ",
        "creator_id": "dd3129da-a515-4d52-bf10-5bac34bcae80",
        "created_at": "2021-11-24T03:38:25+13:00",
        "updated_at": "2021-11-24T03:38:25+13:00",
        "settings": {
        },
        "active_mpd_start_at": null,
        "active_mpd_finish_at": null,
        "active_mpd_monthly_goal": null,
        "salary_organization_id": "defab546-3814-4fa4-b431-4b46cf863c92",
        "primary_appeal_id": null,
        "notify_attempted_at": null,
        "notified_at": null,
        "locked_at": null
      },
      "created_at": "2021-11-23T14:38:25Z",
      "losses": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "month_names": [
        "Nov 2020",
        "Dec 2020",
        "Jan 2021",
        "Feb 2021",
        "Mar 2021",
        "Apr 2021",
        "May 2021",
        "Jun 2021",
        "Jul 2021",
        "Aug 2021",
        "Sep 2021",
        "Oct 2021",
        "Nov 2021"
      ],
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "e22029db-34d1-4980-9840-e4538f25347e",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

account_list

Type Account List

Description The account list this report is for

created_at

Type date

Description The timestamp of when this resource was created

losses

Type [number]

Description The month-over-month losses each month

month_names

Type [string]

Description The name of each month

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this report belongs to