Overview

Custom data allows you to associate data with an Account or Meter that is not directly on the Statement. The data is entirely custom-- customers set up the field labels and maintain the values as needed.

How to name custom data field labels and assign values

There are 10 custom data fields available at both the Account and Meter level. There are 2 steps to successfully setting up custom data.

To get started, you first must name the custom data fields by giving them a label. You can do this from the Dashboard in the Configuration section or using the API endpoint Update Organization Custom Data.
1. Navigate to the gear icon in the top right corner of the Dashboard and select "Custom data".
2. In the "Overview" tab, select the pen icon to edit the custom data field labels for Accounts or Meters. These labels will apply for all Accounts or Meters.
3. In the modal, set the field labels to your needs and select "Save".
With the Account and Meter custom data fields named and labeled, you can now update any specific Account or Meter custom data value. You can associate custom data directly to an Account or Meter from the Dashboard or using the API endpoints Update Account or Update Meter.
1. Navigate to an Account or Meter detail page.
2. Select the tab for "Custom data" and select "Edit custom data".
3. In the modal, assign values for custom data fields and select "Save".

API example

curl --request PATCH \
     --url https://api.arcadia.com/plug/organization \
     --header 'Arc-Version: 2024-02-21' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {token} ' \
     --header 'content-type: application/json' \
     --data '
{
  "accountCustomData1Name": "Department",
  "accountCustomData2Name": "Manager",
  "meterCustomData1Name": "BuildingNumber"
}
'

{
  "accountCustomData10Name": null,
  "accountCustomData1Name": "Department",
  "accountCustomData2Name": "Manager",
  "accountCustomData3Name": null,
  "accountCustomData4Name": null,
  "accountCustomData5Name": null,
  "accountCustomData6Name": null,
  "accountCustomData7Name": null,
  "accountCustomData8Name": null,
  "accountCustomData9Name": null,
  "id": "org_000",
  "meterCustomData10Name": null,
  "meterCustomData1Name": "BuildingNumber",
  "meterCustomData2Name": null,
  "meterCustomData3Name": null,
  "meterCustomData4Name": null,
  "meterCustomData5Name": null,
  "meterCustomData6Name": null,
  "meterCustomData7Name": null,
  "meterCustomData8Name": null,
  "meterCustomData9Name": null,
  "name": "Example Organization"
}

curl --request PATCH \
     --url https://api.arcadia.com/plug/accounts/act_00000000-0000-0000-0000-000000000000 \
     --header 'Arc-Version: 2024-02-21' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {token}' \
     --header 'content-type: application/json' \
     --data '
{
  "customData": {
    "Department": "IT",
    "Manager": "Smith"
  }
}
'

{
 ...
  "customData": {
    "Department": "IT",
    "Manager": "Smith"
  },
 ...
}

curl --request PATCH \
     --url https://api.arcadia.com/plug/meters/meterId \
     --header 'Arc-Version: 2024-02-21' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {token}' \
     --header 'content-type: application/json' \
     --data '
{
  "customData": {
    "BuildingNumber": "007"
  }
}
'

{
 ...
  "customData": {
    "BuildingNumber": "007"
  },
  ...
}

Querying on custom data

You can query on custom data fields using Search and Triage in the Dashboard or using the API endpoints List Accounts and List Meters.

In the Dashboard, custom data fields will be denoted with an icon in the search and filter windows to differentiate between custom columns and default columns.

Event history

For any custom data field label at both the Account and Meter level, you can view the event history for all updates made by any user in the custom data configuration pages.

For the custom data values at both the Account and Meter level, you can view the event history for all updates made by any user in the Account and Meter detail pages.