Get Profile with {profileId}

get

https://api.genability.com/rest/v1/profiles/{profileId}

Return a single profile using the Arcadia {profileId} value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve one usage profile using the Arcadia-generated profileId.

Use this endpoint when you have stored the profileId returned by Arcadia when the profile was created. If you use your own profile identifier, use Get One Profile with providerProfileId instead.

Resource URI

GET /rest/v1/profiles/{profileId}

Path parameters

Parameter	Type	Description
`profileId`	String	Arcadia UUID of the `Profile` object. Required.

Optional response data

By default, the response returns profile metadata and reading summaries. Use query parameters to include additional data:

Parameter	Type	Description
`populateReadings`	Boolean	When `true`, includes reading data. Defaults to `false`.
`populateIntervals`	Boolean	When `true`, includes interval values. Use with `groupBy`. Defaults to `false`.
`populateBaseline`	Boolean	When `true`, includes baseline measures for profiles that include them. Optional.
`groupBy`	String	Groups interval data by `YEAR`, `MONTH`, `DAY`, `HOUR`, or `QTRHOUR`.
`fromDateTime`	DateTime	Start date for returned readings or intervals. Optional.
`toDateTime`	DateTime	End date for returned readings or intervals. Optional.
`autoBaseline`	Boolean	When `true`, moves usage data to the requested `fromDateTime` and `toDateTime` range. Optional.
`useIntelligentBaselining`	Boolean	Used with `autoBaseline` to interpolate and extrapolate usage data. Optional.
`asTariffTimezone`	Boolean	When `true`, returns profile readings and intervals in the account tariff's timezone when a tariff is set. Optional.
`fields`	String	Use `dataStatus` to poll profile processing status. Optional.

For the full data model, profile workflow, parameter list, and detailed examples, see Profiles API.

Example

GET /rest/v1/profiles/b7559f37-8020-4969-8bd1-48d8c3d58976

A successful response returns a standard response payload with type set to UsageProfile and one profile in the results array.

{
  "status": "success",
  "count": 1,
  "type": "UsageProfile",
  "results": [
    {
      "profileId": "b7559f37-8020-4969-8bd1-48d8c3d58976",
      "providerProfileId": "ELECTRICITY_RESIDENTIAL_CA_2012",
      "profileName": "2012 CA Electricity Residential Profile",
      "serviceTypes": "ELECTRICITY",
      "dataStatus": 2
    }
  ]
}

Path Params

profileId

string

required

This is the Arcadia UUID of the Profile object.

Query Params

autoBaseline

boolean

This field enables intelligent baselining feature, which allow you to move usage data to a different time period. (Optional, Default=false). When you set this field to true, also set the fromDateTime and toDateTime to the range you want to move usage data to.

useIntelligentBaselining

boolean

This field works in conjunction with autoBaseline (above) and determines how to interpolate and extrapolate usage data when that is set to true. Read intelligent baselining for details.

populateReadings

boolean

When true, the results will contain Reading Data. The default is false. Reading Data Summaries are always returned when getting a Usage Profile independent of the value of this flag. (Optional). NOTE: This used to be called populateReadingData, which has been deprecated but still works (for now).

populateBaseline

boolean

When true, the results will contain an array of Baseline Measures. Only applies for profiles that were uploaded with them. See below for when and how to do this.

populateIntervals

boolean

When true, the results will contain Interval values. The default is false. NOTE: This must be used in concert with the groupBy parameter.

fromDateTime

date

Start date (with or without a time) of the date range to return intervals and/or readings for. (Optional)

toDateTime

date

End date (with or without a time) of the date range to return intervals and/or readings for. (Optional)

fields

string

To just get the dataStatus field, pass in "dataStatus" (good for polling whether the number crunching is complete). Otherwise ignore this field. (Optional)

asTariffTimezone

boolean

Defaults to false

Defaults to false, will default to true after the week of July 15th. When true and account tariff is set will return profile readings and intervals in tariff's timezone. If true and account tariff not set, profile will return in UTC. If false the profile will be returned in an internal DST aware UTC variant timezone (current functionality).

Responses

Resource URI

Path parameters

Optional response data

Example

200200

400400