Fetches one raw API-access widget.

curl --request GET \
  --url https://api.homepal.se/v1/api-access/widgets/{id}/raw \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "broken": false
    },
    "data": [
      {
        "title": "Fastighet",
        "index": 0,
        "data_type": "string",
        "data": [
          "Fastighet 1",
          "Fastighet 2",
          "Fastighet 3"
        ],
        "unit": null,
        "comparative_display_type": null,
        "comparative_data": null
      },
      {
        "title": "Inrapporterade ärenden",
        "index": 1,
        "data_type": "number",
        "data": [
          4352,
          4123,
          3921
        ],
        "unit": null,
        "comparative_display_type": null,
        "comparative_data": null
      }
    ],
    "meta": {
      "comparative_filter": null,
      "period_filter": {
        "from_date": "2024-01-01",
        "to_date": "2024-12-31"
      },
      "subtitle": null,
      "title": "Ärenden per fastighet",
      "type": "BAR_CHART"
    }
  }
}

GET

api-access

widgets

{id}

raw

Fetches one raw API-access widget.

curl --request GET \
  --url https://api.homepal.se/v1/api-access/widgets/{id}/raw \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "broken": false
    },
    "data": [
      {
        "title": "Fastighet",
        "index": 0,
        "data_type": "string",
        "data": [
          "Fastighet 1",
          "Fastighet 2",
          "Fastighet 3"
        ],
        "unit": null,
        "comparative_display_type": null,
        "comparative_data": null
      },
      {
        "title": "Inrapporterade ärenden",
        "index": 1,
        "data_type": "number",
        "data": [
          4352,
          4123,
          3921
        ],
        "unit": null,
        "comparative_display_type": null,
        "comparative_data": null
      }
    ],
    "meta": {
      "comparative_filter": null,
      "period_filter": {
        "from_date": "2024-01-01",
        "to_date": "2024-12-31"
      },
      "subtitle": null,
      "title": "Ärenden per fastighet",
      "type": "BAR_CHART"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

The ID of the widget.

Query Parameters

companies

string

A comma separted list of company names to filter the data by. If not set, data from all companies the company group has access to will be shown.

Response

200 - application/json

The raw widget payload.

data

object

Show child attributes

data.id

string<uuid>

data.status

object

Show child attributes

data.status.broken

boolean

widget is broken and wont return any data.

Example:

false

data.data

object[]

Show child attributes

data.data.title

string

data.data.index

integer

data.data.data_type

enum<string>

The type of data array.

Available options:

string,

number

data.data.data

data.data.unit

string | null

data.data.comparative_display_type

enum<string> | null

Available options:

PERCENTAGE,

VALUE

data.data.comparative_data

(number | null)[] | null

Example:

[
  {
    "title": "Fastighet",
    "index": 0,
    "data_type": "string",
    "data": ["Fastighet 1", "Fastighet 2", "Fastighet 3"],
    "unit": null,
    "comparative_display_type": null,
    "comparative_data": null
  },
  {
    "title": "Inrapporterade ärenden",
    "index": 1,
    "data_type": "number",
    "data": [4352, 4123, 3921],
    "unit": null,
    "comparative_display_type": null,
    "comparative_data": null
  }
]

data.meta

object

Show child attributes

data.meta.comparative_filter

object

The time period of the comparative data

Show child attributes

data.meta.comparative_filter.from_date

string

Example:

"2024-01-01"

data.meta.comparative_filter.to_date

string | null

Example:

"2024-12-31"

Example:

null

data.meta.period_filter

object

The time period of the metric. If to_date is null then it's is not a period, but an exact date.

Show child attributes

data.meta.period_filter.from_date

string

Example:

"2024-01-01"

data.meta.period_filter.to_date

string | null

Example:

"2024-12-31"

data.meta.subtitle

string | null

Example:

null

data.meta.title

string | null

Example:

"Ärenden per fastighet"

data.meta.type

enum<string>

The type of widget.

Available options:

KEY_FIGURE,

BAR_CHART,

BUBBLE_CHART,

LINE_CHART,

LIST,

MAP,

COMBO_CHART,

PIE_CHART

Example:

"BAR_CHART"

Fetches all dashboards.

⌘I

Guide

API Reference

Fetches one raw API-access widget.

Authorizations

Path Parameters

Query Parameters

Response