Get All Profiles

get

https://api.genability.com/rest/v1/profiles

Query all your usage profiles or ones that match a given criteria. Typical searches involve an accountId (i.e. get me all the profiles for this account), and/or a serviceType.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

accountId

string

Filter all the Profiles for a specific account ID.

providerAccountId

string

Filter all the Profiles for a specific provider account ID.

profileName

string

Filter all the Profiles that match a given name.

serviceTypes

string

Comma separated string of service types to filter by. Possible values include: ELECTRICITY, SOLAR_PV (or solarPv). This is case insensitive.

isDefault

boolean

Only return the profiles that are defaults (true) or not defaults (false).

string

The string of text to search on. This can also be a regular expression, in which case you should set the isRegex flag to true (see below). (Optional)

searchOn

string

Comma separated list of fields to query on. When searchOn is specified, the text provided in the search string field will be searched within these fields. The list of fields to search on depend on the entity being searched for. Read the documentation for the entity for more details on the fields that can be searched, and the default fields to be searched if searchOn is not specified. (Optional)

sortOn

string

Comma separated list of fields to sort on. This can also be input via Array Inputs (see above). (Optional)

sortOrder

string

Comma separated list of ordering. Possible values are ASC and DESC. Default is ASC. If your sortOn contains multiple fields and you would like to order fields individually, you can pass in a comma separated list here (or use Array Inputs, see above). For example, if your sortOn contained 5 fields, and your sortOrder contained ASC,DESC,DESC, these would be applied to the first three items in the sortOn field. The remaining two would default to ASC. (Optional)

groupBy

string

The groupBy value denotes what duration of interval data to return (or group by). When this field is not set, the intervals are not returned. When set, the possible values are: "YEAR", "MONTH", "DAY", "HOUR", "QTRHOUR". (Optional)

clipBy

string

clipBy is optional and should only be set when groupBy (above) is set. clipBy allows you to control the behavior in the case where groupBy and the requested date range do not line up exactly. Possible values are: "OUTER", "INNER". For example, you request interval data and specify groupBy=MONTH with a date range of April 15, 2012 through June 15, 2012, OUTER will include all months that overlap at least part of the requested range, and the response will include the months of April, May and June. INNER will only include the full months within the requested range, so only May is returned. When you pass in a groupBy but do not specify clipBy, INNER is used. (Optional)

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)

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.

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

200200

400400