Get High Impedance Events v2 API

This API fetches and delivers HID events to a customer's data lake/business system.

Note: This API replaces (Obsolete) Get High Impedance Events API.

This is used to request a large data file in the format of your choice (Apache Parquet, ORC, JSON, CSV) for downloading when the request can take several minutes to complete.

  • Data product ID. a385638b-916b-4774-82b7-908727be2cc2

  • Data latency. Three minutes or greater, depending on query parameters.

  • Maximum result size. Millions.

  • Data availability. Last 13 months.

Request

Copy 
POST /dpss/api/v1/subscriptions/{{subscriptionid}}/batch-request
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: {{correlationid}}
DataSubscriberId: {{subscriberid}}
Content-Type: application/json

{
    "filetype": "csv",
    "tokens": {
        "StartEventDate": "2024-01-01",
        "EndEventDate": "2025-01-01",
        "StartReceivedDateTime": "",
        "EndReceivedDateTime": "",
        "Device": "",
        "ElectronicSerialNumber": "",
        "Meter": "",
        "MeterNumber": "",
        "ServicePoint": "9000053409,9002036306,9000910527,9001640122",
        "Premises": "",
        "Transformer": "",
        "Feeder": "",
        "WorkOrderID":"",
        "Status":"",
        "IssueId":"",
        "StatusChangeDate":""
    },
    "isOhsRequest": false
}

Response

Copy 
ServicePointID,MeterId,MeterNumber,ElectronicSerialNumber,TransformerId,PremiseId,EventType,RevenueClass,Phase,TransformerMeterDist,AccountId,ServicePointTimeZone,Days,ImpedanceAvg,ImpedanceHigh,ImpedanceLow,Threshold,NumAffectedServicePoints,LowSameTransformer,AvgSameTransformer,HighSameTransformer,StdDev,EventId,EventDate,ReceivedTime,IssueID,StartDate,EndDate
9000053409,1000589632,54065,2.16.840.1.114416.15.80.1000589632,4779244447-10565779,9000053409,High Impedance,,3,58.70475102,,Eastern Standard Time,1,77.75229903473252,265.4,1,0.2,1,1,47.905359412628925,144.4999975724654,22.44866320024202,3,7/5/2024,0:00,,2024-07-05,2024-07-05,
9001640122,1000165238,479765,2.16.840.1.114416.15.80.1000165238,2769749547-92944240,9001640122,Meter Bypass,,1,,,Eastern Standard Time,1,19.16532245759041,46.399998,1,0.0188,1,1,13.424410740494011,51.40666681925456,6.543209103434695,6,7/3/2024,0:00,,2024-07-03,2024-07-03,
9000910527,1000334105,440721,2.16.840.1.114416.15.80.1000334105,3179040768-10867994,9000910527,Meter Bypass,,2,,,Eastern Standard Time,1,29.419125697651847,38.4,1,0.0311,1,1,18.89999732579153,63.29999923706055,5.857706738732209,6,7/5/2024,0:00,,2024-07-05,2024-07-05,
9002036306,1000120910,691765,2.16.840.1.114416.15.80.1000120910,,9002036306,Res. Neutral Fault,,4,,,Eastern Standard Time,1,,,,,1,,,,,11,7/6/2024,1:47,,2024-07-06,2024-07-06,
9002036306,1000120910,691765,2.16.840.1.114416.15.80.1000120910,,9002036306,Res. Neutral Fault,,4,,,Eastern Standard Time,1,,,,,1,,,,,10,7/6/2024,16:53,,2024-07-06,2024-07-06,

This is used to request a smaller data set 'on demand' with very low latency.

  • Data latency. 1-5 seconds.

  • Maximum result size. 1,000 rows.

  • Data availability. Last 13 months.

Request

Copy 
POST /dpss/api/v1/subscriptions/{{subscriptionid}}/on-demand
Host: k8s.itrontotal.com
Authorization: Bearer {{AccessToken}}
Itron-CorrelationId: 5e08ab90-b77e-4b8e-9b12-5874be4dbc02
DataSubscriberId: {{subscriberid}}
Content-Type: application/json
{
    "StartEventDate": "2025-06-25",
    "EndEventDate": "",
    "StartReceivedDateTime": "",
    "EndReceivedDateTime": "",
    "Device": "",
    "ElectronicSerialNumber": "",
    "Meter": "",
    "MeterNumber": "",
    "ServicePoint": "",
    "Premises": "",
    "Transformer": "",
    "Feeder": "",
    "WorkOrderID":"",
    "Status":"",
    "IssueId":"",
    "StatusChangeDate":""
}

Response

Copy 
[
    {
        "ServicePointID": "9000003096",
        "MeterId": "1000564497",
        "MeterNumber": 201445,
        "ElectronicSerialNumber": "2.16.840.1.114416.15.80.1000564497",
        "TransformerId": "3518443699-10633509",
        "PremiseId": "9000003096",
        "EventType": "Meter Bypass",
        "RevenueClass": {},
        "Phase": 2,
        "TransformerMeterDist": 56.54611114412,
        "AccountId": {},
        "ServicePointTimeZone": "Eastern Standard Time",
        "Days": 0,
        "ImpedanceAvg": 59.711764840518725,
        "ImpedanceHigh": 72.5,
        "ImpedanceLow": 1,
        "Threshold": 0.0729,
        "AffectedSPs": 1,
        "LowSameTransformer": 1,
        "AvgSameTransformer": 36.9561931956742,
        "HighSameTransformer": 61.8583337465922,
        "StdDev": 13.730352293675255,
        "EventId": 6,
        "EventDate": "2024-06-13T00:00:12",
        "ReceivedTime": {},
        "Issueid": {},
        "StartDate": "2024-06-13",
        "EndDate": "2024-06-13",
    }
]

Parameters

Table 18  

Name

Description

Operators

Required

Type

Format

Default

Range

Origination

StartEventDate

Start date being queried as Min(EventDate)

Greater than or equal to

No

Date

YYYY-MM-DD

2020-01-01

(Current UTC Date) to (Current UTC Date - 13 months)

Edge app

EndEventDate

End date being queried as Max(EventDate)

Less than or equal to

No

Date

YYYY-MM-DD

9999-12-31

(Current UTC Date) to (Current UTC Date - 13 months)

Edge app

StartReceivedDatetime

Min ReceivedTime data

Greater than or equal to

No

Date time

YYYY-MM-DDTHH:MM:SSZ

2020-01-01T00:00:00.0Z

(Current UTC Date) to (Current UTC Date - 13 months)

App Platform

EndReceivedDatetime

Max ReceivedTime data

Less than or equal to

No

Date time

YYYY-MM-DDTHH:MM:SSZ

9999-12-31T00:00:00.0Z

(Current UTC Date) to (Current UTC Date - 13 months)

App Platform

Device

The identifier of an electromechanical device that records measurements and/or communicates data on a network

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

ElectronicSerialNumber

The Electronic Serial Number of an electromechanical device that records measurements and/or communicates data on a network

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

Meter

An electromechanical device that records electricity, gas, or water measurements to determine the consumption and usage demand at a Service Point

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

MeterNumber

An electromechanical device that records electricity, gas, or water measurements to determine the consumption and usage demand at a Service Point

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

ServicePoint

A point where a customer meter is installed and electricity, gas, or water consumption is measured

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

Premises

A physical location where a customer consumes the services supplied by your company

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

Transformer

A device that changes the voltage from a distribution voltage to a service voltage, generally less than 480 V, before delivering electricity to a service point

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

Feeder

A line immediately below a substation bank where power exits a substation to serve the demand of all customers connected to the feeder

In list

No

String

N/A

N/A

N/A

CIS

GIS

MDMS

WorkOrderId

The user-entered identifier for the utility work order associated with the HID alarm

In list

No

String

N/A

N/A

N/A

App Platform

Status

The status of the HID alarm

In list

No

String

N/A

N/A

N/A

App Platform

IssueId

The unique identifier for the HID alarm

In list

No

String

N/A

N/A

N/A

App Platform

StatusChangeDate

The date the HID alarm changed status by a user

N/A

No

String

N/A

N/A

N/A

App Platform

Data values

Table 19  

Name

Description

Type

Units

Range

Format

Nullable

Origination

ServicePointId

Service Point ID as of EventDate

String

N/A

N/A

N/A

No

CIS

MDMS

GIS

MeterId

Meter ID as of EventDate

String

N/A

N/A

N/A

No

CIS

MDMS

GIS

MeterNumber

Meter Number as of EventDate

String

N/A

N/A

N/A

Yes

CIS

MDMS

GIS

ElectronicSerialNumber

Electronic Serial Number

String

N/A

N/A

N/A

No

CIS

MDMS

GIS

TransformerId

Transformer ID as of EventDate

String

N/A

N/A

N/A

Yes

CIS

MDMS

GIS

PremiseId

Premise ID as of EventDate

String

N/A

N/A

N/A

Yes

CIS

MDMS

GIS

EventType

'Over Threshold'

String

N/A

N/A

'Over Threshold'

No

Edge app

RevenueClass

Revenue class of the meter

String

N/A

N/A

'Residential'

'Commercial'

'Industrial'

Yes

App Platform

Phase

Phase/meter leg

Integer

N/A

1 to 4

N

No

App Platform

TransformerMeterDist

Distance between transformer and meter

Real

Meters

0 to 5,000,000

N.NN

No

App Platform

AccountId

Account ID, if populated

String

N/A

N/A

N/A

Yes

App Platform

ServicePointTimeZone

Time zone of service point

String

N/A

N/A

N/A

No

App Platform

Days

Number of days over impedance threshold

Integer

Days

1 to 5,000,000

N

No

App Platform

ImpedanceAvg

Average impedance on days with impedance over threshold

Real

mOhm

1 to 500

N.NN

No

App Platform

ImpedanceHigh

Maximum impedance on days over impedance threshold

Real

mOhm

1 to 500

N.NN

No

App Platform

ImpedanceLow

Minimum impedance on days over impedance threshold

Real

mOhm

1 to 500

N.NN

No

App Platform

Threshold

Threshold of impedance above which service point is considered high impedance

Real

mOhm

1 to 500

N.NN

No

App Platform

AffectedSPs

CSV list of service points

List

N/A

N/A

N/A

No

App Platform

LowSameTransformer

Minimum of impedances across service points on the same transformer over the last 30 days

Real

mOhm

1 to 500

N.NN

No

App Platform

AvgSameTransformer

Average of impedances across service points on the same transformer over the last 30 days

Real

mOhm

1 to 500

N.NN

No

App Platform

HighSameTransformer

Maximum of impedances across service points on the same transformer over the last 30 days

Real

mOhm

1 to 500

N.NN

No

App Platform

StdDev

Standard deviation of impedances on days over impedance threshold

Real

mOhm

1 to 500

N.NN

No

App Platform

EventId

Identifier of the specific event

Integer

N/A

N/A

N

No

App Platform

EventDate

UTC day for which the statistics have been collected

Date

N/A

N/A

YYYY-MM-DD

No

Edge app

ReceivedTime

When App Platform record is created

Date time

N/A

N/A

YYYY-MM-DDTHH:MM:SSZ

No

App Platform

IssueId

The unique identifier for the HID alarm

String

N/A

N/A

N/A

No

App Platform

StartDate

The date the HID alarm started

Date

N/A

N/A

YYYY-MM-DD

No

App Platform

EndDate

The date the HID alarm ended

Date

N/A

N/A

YYYY-MM-DD

No

App Platform