SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Metrics Metadata API

API for creating, retrieving, updating, and deleting metric names and MTS metadata.

NOTE:* Although you can't set custom properties or tags for a metric, you can retrieve them for metrics and metric time series (MTS**).

Retrieve Dimensions Query

Retrieves dimensions based on a query

get /dimension

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/dimension

Retrieves the dimensions objects for the search criteria you specify in the query query parameter.

The query can contain one or more of the following:

  • Dimension names
  • Dimension names and values
  • Custom property names

The API first collects all of the matching results. This is known as the result set. Depending on the values you specify for offset and limit, the number of metadata objects in the response body can be smaller than than the result set. For example, if you specify offset=0 (the default) and limit=50, and the API finds 100 matches, you only receive the first 50 results.

query Parameters
query
string

Search criteria for the dimensions you want to retrieve

Use this syntax:

  • To search for a dimension name use query=key:<dimension_name>
  • To search for specific values of a dimension use the name and value as query=<name>:<value>. If <value> contains non-alphanumeric characters (for example, blanks), surround it with double quotes.
  • Use * as a wildcard character. For example, to search for all values of the region dimension, use query=region:*.
  • To search for the existence of dimensions, use _exists_ and _missing_. For example, to search for metadata that has the host_machine dimension, specify query=_exists_:host_machine.
  • A single dimension name or name-value pair (or wildcards) make up a predicate that implicitly returns a boolean.
  • Join predicates with the NOT, AND, and OR boolean operators.
  • Use parentheses '(' and ')' to change the evaluation order. For example, to retrieve all metadata that has the dimensions region:emea and hostname:france-*, use query=region:emea AND hostname:france-*.
orderBy
string

Metadata object property on which the API should sort the results. This must be a property of the dimensions metadata object.

offset
integer <int32>

Object in the result set at which the API should start returning results to you. If omitted, the API starts at the first result in the set.

limit
integer <int32>

Number of results to return from the result set

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
count
integer

Number of metadata objects that matched the search criteria. This isn't the same as sizeOf(results), because the limit and offset query parameters affect the number of objects in the response body.

results
Array of objects (DimensionMetadata)

List of dimension metadata objects, in the form of an array of JSON objects. Each object contains metadata for a dimension that matched the query.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "results":
    [
    ]
}

Retrieve Dimension Metadata Name Value

Retrieves metadata for a dimension and value

get /dimension/{key}/{value}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/dimension/{key}/{value}

Retrieves the metadata for the dimension and value specified in the key and value path parameters

path Parameters
key
required
string

Dimension name

value
required
string

Dimension value

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
created
integer <int64>

Dimension creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who "created" the dimension. This can be one of the following:

  • User who created the integration that sent the dimension
  • User who sent the dimension using the API
  • User who added the dimension using the UI

If the value is "AAAAAAAAAAA", SignalFx created the dimension.

customProperties
object <= 50 items

Dimension custom properties, in the form of a JSON object containing custom property key-value pairs. Names and values have these requirements:

Name:

  • UTF-8 string, maximum length of 128 characters (512 bytes)
  • Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (_) and hyphens (-).
  • Must not start with the underscore character (_)

Value:

  • String: Maximum length 256 UTF-8 characters (1024 bytes)
  • Integer or float: Maximum length 8192 bits (1024 bytes)
description
string <UTF-8> [ 0 .. 1024 ] characters

Dimension description, up to 1024 UTF-8 characters

key
string <= 128 characters

Dimension name. It has these requirements:

  • UTF-8 string, maximum length of 128 characters (512 bytes)
  • Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (_) and hyphens (-).
  • Must not start with the underscore character (_)
  • Must not start with the prefix sf_, except for dimensions defined by SignalFx such as sf_hires
  • Must not start with the prefix aws_
lastUpdated
integer <int64>

Last updated timestamp, in Unix time

lastUpdatedBy
string

SignalFx-assigned ID of the user who last updated the dimension by modifying its metadata. If the value is "AAAAAAAAAAA", SignalFx last modified the dimension.

tags
Array of strings <= 50 items

Tags for the dimension, in the form of a JSON array of tag names

Each tag is a UTF-8 string, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available.

NOTE: You can't have more than 50 tags per MTS, so you can't have more than 50 tags total for all of the dimensions associated with the MTS.

value
string <= 256 characters

Dimension value. It has these requirements:

  • String: Maximum length 256 UTF-8 characters (1024 bytes)
  • Integer or float: Maximum length 8192 bits (1024 bytes)

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1555065030000,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "key": "string",
  • "lastUpdated": 1555237830000,
  • "lastUpdatedBy": "string",
  • "tags":
    [
    ],
  • "value": "string"
}

Update Dimension Metadata

Overwrites metadata for the specified dimension

put /dimension/{key}/{value}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/dimension/{key}/{value}

Overwrites metadata for the dimension specified by the name and value in the path parameters.

This method uses overwrite semantics. Properties in the request body overwrite existing values. If a property exists and you omit it from the request body, the API sets it to null.

path Parameters
key
required
string

Name of the dimension you want to update

value
required
string

Value of the dimension you want to update

header Parameters
X-SF-TOKEN
required
string

Authentication token

Request Body schema: application/json

Custom properties or tags (or both) that you want to add or update for the specified dimension key and value

customProperties
object

Custom property updates. Because PUT /dimension/{key}/{value} has overwrite semantics, you need to include existing custom properties when you update; otherwise, they're deleted.

  • To change the value of a custom property, use "<property_name>": "<new_value>".
  • To add a custom property, use "<new_property_name>": "<value>"
description
string <UTF-8> [ 0 .. 1024 ] characters

Updated dimension description

key
string <= 128 characters

Dimension name for which you want to update metadata

tags
Array of strings <= 50 items

List of tags you want to add, in the form of a JSON array. Because PUT /dimension/{key}/{value} has overwrite semantics, you need to include existing tags when you update tags or custom properties; otherwise, they're deleted.

value
string <= 256 characters

Dimension value for which you want to update metadata

Responses

200

Success

Response Schema: application/json
created
integer <int64>

Creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who "created" the dimension. This can be one of the following:

  • User who created the integration that sent the dimension
  • User who sent the dimension using the API
  • User who added the dimension using the UI

If the value is "AAAAAAAAAAA", SignalFx created the dimension.

customProperties
object <= 50 items

Custom properties for the dimension, in the form of a JSON object containing custom property key-value pairs

description
string <UTF-8> [ 0 .. 1024 ] characters

Dimension description, up to 1024 UTF-8 characters

key
string <= 128 characters

Name of the updated dimension

lastUpdated
integer <int64>

Last updated timestamp, in Unix time

lastUpdatedBy
string

SignalFx-assigned ID of the user who last updated the metric by modifying its metadata. If the value is "AAAAAAAAAAA", SignalFx last modified the metric.

tags
Array of strings <= 50 items

List of tags for the dimension, in the form of a JSON array of strings

value
string <= 256 characters

Value of the updated dimension

Request samples

application/json
Copy
Expand all Collapse all
{
  • "customProperties": { },
  • "description": "string",
  • "key": "string",
  • "tags":
    [
    ],
  • "value": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1557484230100,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "key": "string",
  • "lastUpdated": 1557570630000,
  • "lastUpdatedBy": "string",
  • "tags":
    [
    ],
  • "value": "string"
}

Retrieve Metadata Metrics Query

Retrieve metadata for metrics

get /metric

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/metric

Retrieves metadata objects for which the metrics name matches the search criteria.

The API first collects all of the matching results. This is known as the result set. Depending on the values you specify for offset and limit, the number of metadata objects in the response body can be smaller than than the result set. For example, if you specify offset=0 (the default) and limit=50, and the API finds 100 matches, you only receive the first 50 results.

query Parameters
query
string

Metric name search string. The string always starts with name:. You have the following search options:

  • To search by metric name, use name:<metric_name>. This returns all of the metadata for that metric.
  • To search for names using wildcards, use * as the wildcard character. For example, to search for all the metrics that start with cpu., use name:cpu.*. This returns metadata for cpu.utilization, cpu.num_cores, and so forth.
orderBy
string

Result object property on which the API should sort the results. This must be a property of the metrics metadata object.

offset
integer <int32>
Default: 0

Object in the result set at which the API should start returning results to you. If omitted, the API starts at the first result in the set.

limit
integer <int32>

Number of results to return from the set of all metrics that match the query.

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
count
integer

Number of metadata objects that matched the specified metrics name. This isn't the same as sizeOf(results), because the limit and offset query parameters affect the number of objects the API returns in the response body.

result
Array of objects (MetricsMetadata)

List of results, in the form of a JSON array of metadata objects

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "result":
    [
    ]
}

Retrieve Metadata Metric Name

Retrieves the metadata for a metric name

get /metric/{name}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/metric/{name}

Retrieves the metadata for the metric name specified in the {name} path parameter. The API returns all of the metadata for this metric.

path Parameters
name
required
string
Example: "network.usage.rx_bytes"

Name of an existing metric. For example, to retrieve the metadata for the cpu.utilization metric, use the endpoint https://api.{REALM}.signalfx.com/v2/metric/cpu.utilization

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
created
integer <int64>

Metric creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who "created" the metric. This can be one of the following:

  • User who created the integration that sent the metric
  • User who sent the metric using the API

If the value is "AAAAAAAAAAA", SignalFx created the metric.

customProperties
object <= 50 items

Custom properties retrieved for the metric, in the form of a JSON object. Each property is a key-value pair.

description
string <UTF-8> [ 0 .. 1024 ] characters

Description of the metric

lastUpdated
integer <int64>

Last updated timestamp for the metric, in Unix time

lastUpdatedBy
string

SignalFx-assigned ID of the user who last updated the metric by modifying its metadata. If the value is "AAAAAAAAAAA", SignalFx last modified the metric.

name
string

Name of the metric

tags
Array of strings <= 50 items

List of tags associated with the metric, in the form of a JSON array of strings.

type
string
Enum:"GAUGE" "COUNTER" "CUMULATIVE_COUNTER"

Metric type of the metric. Possible values are "GAUGE", "COUNTER", or "CUMULATIVE_COUNTER".

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1556055030000,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "lastUpdated": 1556141430000,
  • "lastUpdatedBy": "string",
  • "name": "string",
  • "tags":
    [
    ],
  • "type": "GAUGE"
}

Retrieve Metric Timeseries Metadata

Retrieves metric timeseries (MTS) metadata based on a query

get /metrictimeseries

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/metrictimeseries

Retrieves metadata for the metric timeseries specified by the search criteria in the query query parameter.

The query can contain one or more of the following:

  • Metric name
  • Dimensions
  • Custom properties
  • Tags

The API first collects all of the matching results. This is known as the result set. Depending on the values you specify for offset and limit, the number of metadata objects in the response body can be smaller than than the result set. For example, if you specify offset=0 (the default) and limit=50, and the API finds 100 matches, you only receive the first 50 results.

query Parameters
query
string

Search criteria that selects the metric timeseries for which you want metadata.

Search criteria have the following rules:

  • To search by metric name, use query=name:<metric_name>. The result metadata for MTS that have that metric name.
  • To search by dimension name, use query=<dimension_name>:*. The result is metadata for MTS that have a dimension with that dimension name, regardless of metric name.
  • To search by dimension, use query=<dimension_name>:<value>. The result is metadata for MTS that have that dimension, regardless of metric name.
  • If <value> contains non-alphanumeric characters (for example, blanks), surround it with double quotes.
  • To search with a wildcard character, use *. For example, to search for all of the values of the region dimension, use query=region:*.
  • To search for the existence of dimensions or properties, use _exists_ and _missing_. For example, to search for metadata that has the host_machine dimension, specify query=_exists_:host_machine.
  • A single name and value (or wildcards) make up a predicate that implicitly returns a boolean.
  • Join predicates with the NOT, AND, and OR boolean operators.
  • Use parentheses '(' and ')' to change the evaluation order. For example, to retrieve all metadata that has the dimension region:emea and the custom property company with values that start with Schneider*, use query=region:emea AND company:Schneider*.
orderBy
string

Metadata property on which the API should sort the results. You don't have to include this property in the query, but the name must be metadata for an MTS.

offset
integer <int32>

Position of a result object that contains metadata for a single match within the entire set of results of the query. The API starts returning results at this point. If omitted, the API starts at the first result in the set.

limit
integer <int32>

Number of result objects to return from the result set.

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
count
integer

Number of metadata objects that matched the search criteria. This isn't the same as the size of results, because the limit and offset query parameters affect the number of objects in the response body.

results
Array of objects (MTSMetadata)

List of metadata for retrieved MTS, in the form of a JSON array. Each element contains metadata for a single MTS.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "results":
    [
    ]
}

Retrieve MTS Metadata ID

Retrieves the MTS metadata for a metric timeseries

get /metrictimeseries/{id}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/metrictimeseries/{id}

Retrieves metadata for the single metric timeseries specified by the {id} path parameter.

path Parameters
id
required
string

SignalFx-assigned ID of the MTS for which you want metadata

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success

Response Schema: application/json
created
integer <int64>

MTS creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who "created" the MTS. This can be one of the following:

  • User who created the integration that sent the MTS
  • User who sent the MTS using the API

If the value is "AAAAAAAAAAA", SignalFx created the MTS.

customProperties
object <= 50 items

MTS custom properties, in the form of a JSON object. Each object property is a custom property key-value pair. The section Custom Properties Criteria lists the requirements for custom properties.

dimensions
object <= 50 items

MTS dimensions, in the form of a JSON object. Each object property is a dimension key-value pair. The section Dimension Criteria lists the requirements for dimensions.

lastUpdated
integer <int64>

MTS last updated timestamp, in Unix time

lastUpdatedBy
string

SignalFx-assigned ID of the user who last updated the MTS by modifying its metadata. If the value is "AAAAAAAAAAA", SignalFx last modified the metric.

metric
string <= 256 characters

MTS metric name. Metric names are UTF-8 strings with a maximum length of 256 characters (1024 bytes).

tags
Array of strings <= 50 items

MTS tags, in the form of a JSON array of strings.

Each tag is in UTF-8, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available.

type
string
Enum:"GAUGE" "COUNTER" "CUMULATIVE_COUNTER"

Metric type of the MTS. The possible values are "GAUGE", "COUNTER", and "CUMULATIVE_COUNTER".

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1557743430000,
  • "creator": "string",
  • "customProperties": { },
  • "dimensions": { },
  • "lastUpdated": 1557916230000,
  • "lastUpdatedBy": "string",
  • "metric": "string",
  • "tags":
    [
    ],
  • "type": "GAUGE"
}

Retrieve Tag Metadata Query

Retrieves metadata for tags

get /tag

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/tag

Retrieves metadata for which the tag matches the search criteria.

The API first collects all of the matching results. This is known as the result set. Depending on the values you specify for offset and limit, the number of metadata objects in the response body can be smaller than than the result set. For example, if you specify offset=0 (the default) and limit=50, and the API finds 100 matches, you only receive the first 50 results.

query Parameters
query
string

Search criteria for tags.

Use the following syntax rules:

  • To search for a tag, specify query=<tagname>.
  • Use * as a wildcard. For example, to search for tags that start with the string "python", use `query="python*".
orderBy
string

Result object property on which the API should sort the results. This must be a property of the tag metadata object.

offset
integer <int32>

Object in the result set at which the API should start returning results to you. If omitted, the API starts at the first result in the set.

limit
integer <int32>

Number of results to return from the result set.

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Success criteria

Response Schema: application/json
count
integer

Number of metadata objects that matched the specified search criteria. This isn't the same as sizeOf(results), because the limit and offset query parameters affect the number of objects the API returns in the response body.

results
Array of objects (TagMetadata)

Tag metadata for tags that matched the search criteria, in the form of an array of JSON objects.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "results":
    [
    ]
}

Delete Single Tag

Deletes a tag

delete /tag/{name}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/tag/{name}

Deletes the tag specified in the {name} path parameter

path Parameters
name
required
string

Tag you want to delete

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

204

Success

404

Unable to find the specified tag

Retrieve Tag Metadata Name

Retrieves metadata for a tag

get /tag/{name}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/tag/{name}

Retrieves the metadata for the tag specified in the {name} path parameter. The API returns all of the metadata for this tag.

path Parameters
name
required
string

Tag you want to retrieve

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

200

Successful retrieval of tag metadata for a specified tag

Response Schema: application/json
created
integer <int64>

Tag creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who "created" the tag. This can be one of the following:

  • User who created the integration that sent the tag
  • User who sent the tag using the API

If the value is "AAAAAAAAAAA", SignalFx created the tag.

customProperties
object

Custom properties for the tag, in the form of a JSON object. Each property in the object is a custom property key-value pair. The section Custom Properties Criteria lists the requirements for custom property keys and values.

description
string <UTF-8> [ 0 .. 1024 ] characters

Tag description, up to 1024 UTF-8 characters.

lastUpdated
integer <int64>

Tag last updated timestamp, in Unix time

lastUpdatedBy
string

SignalFx-assigned ID of the user who last updated the tag by modifying its metadata. If the value is "AAAAAAAAAAA", SignalFx last modified the tag.

name
string <UTF-8> <= 256 characters

Tag value, in UTF-8. The section Tags Criteria lists the requirements for tags.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1554287430000,
  • "creator": "string",
  • "customProperties":
    {
    },
  • "description": "string",
  • "lastUpdated": 1555497030000,
  • "lastUpdatedBy": "string",
  • "name": "string"
}

Create Update Tag

Creates or updates a tag

put /tag/{name}

SignalFx API server

Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.

To find your realm, go to your profile page in the SignalFx web UI.

If you don't include a realm and use https://api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{realm}.signalfx.com/v2/tag/{name}

Creates or updates the tag specified in the {name} path parameter.

path Parameters
name
required
string

Data for the tag you want to create or update. The section Tags Criteria lists the requirements for tags.

header Parameters
Content-Type
required
string

Format of the request body. Always "application/json".

X-SF-TOKEN
required
string

Authentication token

Request Body schema: application/json

Metadata for the tag you want to create or update

customProperties
object <= 50 items

Custom properties for the tag, in the form of a JSON object. Each property is a custom property name and value. The section Custom Properties Criteria lists the requirements for custom property names and values.

description
string <UTF-8> [ 0 .. 1024 ] characters

Tag description, up to 1024 UTF-8 characters.

name
any

Tag name, as specified in the {name} path parameter

Responses

200

Success

Response Schema: application/json
created
integer <int64>

Tag creation timestamp, in Unix time

creator
string

SignalFx-assigned ID of the user who created or updated the tag. If the value is "AAAAAAAAAAA", SignalFx created or updated the tag.

customProperties
object <= 50 items

Custom properties created for or added to the tag, in the form of a JSON object. Each property is a custom property name and value. The section Custom Properties Criteria lists the requirements for custom property names and values.

description
string

Tag description

lastUpdated
integer <int64>

Tag last updated timestamp, in Unix time. If this is a new tag, lastUpdated == created.

lastUpdatedBy
any

SignalFx-assigned ID of the user who last updated the tag. If the value is "AAAAAAAAAAA", SignalFx last updated the metric.

name
string

Tag name

Request samples

application/json
Copy
Expand all Collapse all
{
  • "customProperties": { },
  • "description": "string",
  • "name": null
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "created": 1554287430000,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "lastUpdated": 1555497030000,
  • "lastUpdatedBy": null,
  • "name": "string"
}

© Copyright 2019 SignalFx.

Third-party license information