/config/push/options

The options controlling how data is pushed to the remote web server. Multiple options must be separated by commas (,).

This resource is available only if /config/push/service is an empty string.

Available options are:

  • day: Data will be pushed with day granularity (at most one row of data per day).

  • deflate: Use the deflate algorithm to compress the push data. This adds HTTP header Content-Encoding: deflate to the POST request.

  • epoch: Report the register values relative to the epoch. Without this option, absolute values are sent which start at zero at the time the meter database was created.

  • gzip: Use the gzip algorithm to compress the push data. This adds HTTP header Content-Encoding: gzip to the POST request.

  • json: Push data in JSON format instead of XML. The JSON format is the same as the one returned by the /register service, except that the top-level ts section and the idx members in the registers section are omitted since they are not meaningful for push data.

  • hour: Data will be pushed with hour granularity (at most one row of data per hour).

  • max=n: Pushed at most n rows in a single POST request. This limit must be in the range from 1 to 900.

  • msec: Data will be pushed with millisecond granularity (at most one row of data per millisecond).

  • old_first: Push the oldest data row first. By default, the youngest data row is pushed first.

  • sec: Data will be pushed with second granularity (at most one row of data per second).

  • secure: If this option is present, secure connections to the remote web server are allowed only if the server possesses a certificate that the meter can verify as authentic. Without this option, the server's certificate is not verified. This option is ignored if /config/net/http/client/insecure is true.

  • skip=n: Push only every (n+1)-th data row. For example, with hour granularity and skip=2, data rows would be spaced apart by (at least) 3 hours. They may be spaced apart more depending on the rows that are available in the database.

  • totals: Push not just the physical registers but also the virtual registers.

By default, data is pushed with minute granularity (at most one row of data per minute).

Get /config/push/options

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

get/config/push/options
Request samples
Response samples
application/json
{
  • "result": "json,gzip,epoch,sec,skip=59",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/push/options

SecurityApiKey
Request
Request Body schema: application/json
string (configPushOptions)

The options controlling how data is pushed to the remote web server. Multiple options must be separated by commas (,).

This resource is available only if /config/push/service is an empty string.

Available options are:

  • day: Data will be pushed with day granularity (at most one row of data per day).

  • deflate: Use the deflate algorithm to compress the push data. This adds HTTP header Content-Encoding: deflate to the POST request.

  • epoch: Report the register values relative to the epoch. Without this option, absolute values are sent which start at zero at the time the meter database was created.

  • gzip: Use the gzip algorithm to compress the push data. This adds HTTP header Content-Encoding: gzip to the POST request.

  • json: Push data in JSON format instead of XML. The JSON format is the same as the one returned by the /register service, except that the top-level ts section and the idx members in the registers section are omitted since they are not meaningful for push data.

  • hour: Data will be pushed with hour granularity (at most one row of data per hour).

  • max=n: Pushed at most n rows in a single POST request. This limit must be in the range from 1 to 900.

  • msec: Data will be pushed with millisecond granularity (at most one row of data per millisecond).

  • old_first: Push the oldest data row first. By default, the youngest data row is pushed first.

  • sec: Data will be pushed with second granularity (at most one row of data per second).

  • secure: If this option is present, secure connections to the remote web server are allowed only if the server possesses a certificate that the meter can verify as authentic. Without this option, the server's certificate is not verified. This option is ignored if /config/net/http/client/insecure is true.

  • skip=n: Push only every (n+1)-th data row. For example, with hour granularity and skip=2, data rows would be spaced apart by (at least) 3 hours. They may be spaced apart more depending on the rows that are available in the database.

  • totals: Push not just the physical registers but also the virtual registers.

By default, data is pushed with minute granularity (at most one row of data per minute).

Responses
200

Normal response.

401

Unauthorized response.

put/config/push/options
Request samples
application/json
"json,gzip,epoch,sec,skip=59"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/push/options

SecurityApiKey
Request
Request Body schema: application/json
string (configPushOptions)

The options controlling how data is pushed to the remote web server. Multiple options must be separated by commas (,).

This resource is available only if /config/push/service is an empty string.

Available options are:

  • day: Data will be pushed with day granularity (at most one row of data per day).

  • deflate: Use the deflate algorithm to compress the push data. This adds HTTP header Content-Encoding: deflate to the POST request.

  • epoch: Report the register values relative to the epoch. Without this option, absolute values are sent which start at zero at the time the meter database was created.

  • gzip: Use the gzip algorithm to compress the push data. This adds HTTP header Content-Encoding: gzip to the POST request.

  • json: Push data in JSON format instead of XML. The JSON format is the same as the one returned by the /register service, except that the top-level ts section and the idx members in the registers section are omitted since they are not meaningful for push data.

  • hour: Data will be pushed with hour granularity (at most one row of data per hour).

  • max=n: Pushed at most n rows in a single POST request. This limit must be in the range from 1 to 900.

  • msec: Data will be pushed with millisecond granularity (at most one row of data per millisecond).

  • old_first: Push the oldest data row first. By default, the youngest data row is pushed first.

  • sec: Data will be pushed with second granularity (at most one row of data per second).

  • secure: If this option is present, secure connections to the remote web server are allowed only if the server possesses a certificate that the meter can verify as authentic. Without this option, the server's certificate is not verified. This option is ignored if /config/net/http/client/insecure is true.

  • skip=n: Push only every (n+1)-th data row. For example, with hour granularity and skip=2, data rows would be spaced apart by (at least) 3 hours. They may be spaced apart more depending on the rows that are available in the database.

  • totals: Push not just the physical registers but also the virtual registers.

By default, data is pushed with minute granularity (at most one row of data per minute).

Responses
200

Normal response.

401

Unauthorized response.

post/config/push/options
Request samples
application/json
"json,gzip,epoch,sec,skip=59"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/push/options

Reset to empty string.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/push/options
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}