SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Backfill API

API for for sending historical MTS to SignalFx

Backfill MTS

Sends historical MTS to SignalFx

post /backfill

SignalFx Backfill API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://backfill.eu0.signalfx.com/v1.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https://backfill.signalfx.com/v1, SignalFx interprets the endpoint as pointing to the us0 realm.

https://backfill.{REALM}.signalfx.com/v1/backfill

Sends historical MTS to SignalFx, overwriting any existing datapoints for the same time period. Be aware of the following when you use /backfill:

  • A single call to /backfill can only refer to a single MTS specified by its metric type, metric name, and dimensions.
  • Use the API in "bulk" mode. It's designed to accept thousands of datapoints in each call, such as 1 hour of points with a resolution of one second or one day of points with a resolution of one minute.
  • Timestamps for each datapoint must be monotonically ascending.
  • A single call to /backfill must contain one or more hour-long groups of datapoints, with each hour starting one millisecond after the top of the hour and ending exactly at the top of the following hour.
  • Avoid large gaps in the data, because the provided data replaces all of the data in the equivalent time period of existing data. For example, if you have one hundred datapoints for an MTS over one hour, and you backfill with 20 datapoints for the same MTS over the same hour, you're left with 20 datapoints.
  • NOTE:* /backfill doesn't support the built-in sf_hires dimension that marks datapoints as high resolution.
query Parameters
orgid
required
string

The SignalFx ID for the organization that should receive the incoming data

metric_type
string
Enum:"gauge" "counter" "cumulative_counter"

The metric type for the metric you're backfilling. Allowed values are gauge, counter, and cumulative_counter.

metric
required
string

The name of the metric in the MTS that you're backfilling

sfxdim_<dimension_name>
string

Designates one of the dimension names that identify the MTS you're backfilling. Specify one parameter for each dimension, up to the limit of 36 dimensions.
Note: You must specify all the dimensions associated with the MTS. If you don't, the backfill creates a new MTS based on the dimensions you specify.

header Parameters
Content-Type
required
string

The media type ("MIME type") of the request body. Must be set to `application/json'.

X-SF-TOKEN
required
string

Org token (referred to as an access token in the web UI) that has authorization to backfill datapoints to your organization.

Request Body schema: application/json
timestamp
required
integer <int64>

Timestamp of the historical datapoint, expressed in Unix epoch time (milliseconds since 1970-01-01 00:00:00 UTC+0). Values of timestamp must be monotonically ascending the request body.

value
required
number

The metric value, as an integer or floating-point number

Responses

200

Successful backfill request. The API doesn't return headers or a response body

Request samples

application/json
Copy
Expand all Collapse all
{
  • "timestamp": 1000198800,
  • "value": 400
}

© Copyright 2019 SignalFx.

Third-party license information