SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Dashboards API

API for creating, retrieving, updating, and deleting dashboards and dashboard groups.
Dashboards are groups of charts. In a dashboard, all the charts that belong to the dashboard appear at the same time and follow the same filtering options.

Dashboard layout

The system lays out dashboards and the charts they contain with these dimensions:

  • The web UI reserves a 12x100 grid for each dashboard and assigns one or more charts to specific locations within the grid.
  • A chart associated with the dashboard can be any size from 1x1 to 12x3.
  • If you assign overlapping dashboard locations for charts, the system attempts to resize or reorganize the layout. This ensures that all of the charts fit within the space alloted to the dashboard.

Dashboard access

By default, all users in an organization can edit and delete dashboards and dashboard groups. If SignalFx has enabled the "write permissions" feature for your organization, you can limit editing or deleting of specific dashboards to specific individuals or teams, or both. Use this feature to prevent unauthorized or accidental modifications to dashboards and the charts they contain.

Cloning dashboards

Users who don't have permission to edit a dashboard can still clone it and modify the clone.

Mirrored dashboards

In addition to cloning dashboards, you can mirror an existing dashboard in another group. The mirror is actually a link to the original object, so changes that you make to the original affect the mirror and vice versa. In addition, you can apply limited overrides to the mirror that don't affect the original. To create a mirrored dashboard, use the operation PUT https://api.{REALM}.signalfx.com/v2/dashboardgroup/{GROUP_ID}, described in the Dashboard Groups REST API reference.

View dashboards

You can view dashboards you create using the API in the web UI by specifying their "id" property in a web UI URL, by following this syntax:
https://app.signalfx.com/#/dashboard/<DASHBOARD_ID>
Dashboards you create using the API also appear by name in the web UI catalog and in their dashboard group.

Create Single Dashboard

Creates a single dashboard

post /dashboard

SignalFx API endpoint.
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/dashboard

Creates a dashboard using the properties specified in the request body. If your organization has the "write permissions" feature enabled, you can specify the users and teams that who have permission to edit or delete the dashboard or its charts.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token, either an org token (referred to as an Access Token in the web UI) or a session token (referred to as a User API Access Token in the web UI).

Request Body schema: application/json
authorizedWriters
object (Organizations and teams with write permission for an object)

If your organization has the "write permissions" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

chartDensity
string (DashboardChartDensity)
Default: "DEFAULT\\\""
Enum:"DEFAULT" "LOW" "HIGH" "HIGHEST"

Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:

  • DEFAULT maps to approximately 60 data points
  • LOW maps to approximately 30 data points
  • HIGH maps to approximately 120 data points
  • HIGHEST maps to approximately 240 data points
charts
Array of object (DashboardChartsArray)

Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.

description
string (DashboardDescription)

Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.

eventOverlays
Array of object (DashboardEventOverlaysArray)

Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.
Note: The objects in this array correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.

filters
object (Filters to apply to all the charts of a dashboard)

Specifies the properties of filters to apply to the dashboard.
Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria.
You can also use filters to apply a custom time window to all of the charts in the dashboard.

groupId
string (DashboardGroupId)

ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.

maxDelayOverride
integer <int32> (DashboardMaxDelayOverride)

Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn't change the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.
For individual charts, you can force the system to calculate a sensible value by removing the chart's maxDelayOverride property. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.

name
string (DashboardName)

A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.

selectedEventOverlays
Array of object (DashboardSelectedEventOverlaysArray)

Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.

Responses

200

Successful dashboard creation

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json; charset=utf8"

Format of the response payload.

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 UTC+0"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is UTC+0

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

X-Content-Type-Options
string
Default: "nosniff"

Indicates that front-end clients shouldn't attempt to determine the payload format and adjust the content-type to match their expectations.

Response Schema: application/json
authorizedWriters
object (Organizations and teams with write permission for an object)

If your organization has the "write permissions" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

chartDensity
string (DashboardChartDensity)
Default: "DEFAULT\\\""
Enum:"DEFAULT" "LOW" "HIGH" "HIGHEST"

Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:

  • DEFAULT maps to approximately 60 data points
  • LOW maps to approximately 30 data points
  • HIGH maps to approximately 120 data points
  • HIGHEST maps to approximately 240 data points
charts
Array of object (DashboardChartsArray)

Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.

created
integer <int64> (DashboardCreated)

The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.

creator
string (DashboardCreator)

SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is "AAAAAAAAAA". The system sets this value, and you can't modify it.

customProperties
object (DashboardCustomPropertiesObject)

Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:
Key:

  • ASCII characters only
  • Length <= 128 characters
  • Can only contain upper and lower case alphanumeric characters, underscores ("_"), and hyphens ("-")
  • Must start with an alphabetic character, upper or lower case.
  • Can't start with any of the following strings, which are reserved for system use: "", "sf", "aws_", or "gcp_".
    Value:
  • Must be present if you specify a key
  • Must not be empty
  • ASCII characters only
  • Length <= 256 characters
description
string (DashboardDescription)

Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.

discoveryOptions
object (DashboardDiscoveryOptionsObject)

Reserved for system use

eventOverlays
Array of object (DashboardEventOverlaysArray)

Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.
Note: The objects in this array correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.

filters
object (Filters to apply to all the charts of a dashboard)

Specifies the properties of filters to apply to the dashboard.
Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria.
You can also use filters to apply a custom time window to all of the charts in the dashboard.

groupId
string (DashboardGroupId)

ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.

id
string (DashboardId)

The dashboard's SignalFx-assigned ID. This value is "read-only" for a create request. The system assigns it and returns it to you in the response.

lastUpdated
integer <int64> (DashboardLastUpdated)

The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is "read-only".

lastUpdatedBy
string (DashboardLastUpdatedBy)

SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is "AAAAAAAAAA". This value is "read-only".

locked
boolean (DashboardLocked)

Flag that controls modification of the dashboard. If true, users can't modify the dashboard. If false, users that have authorization to access the dashboard can edit it.

maxDelayOverride
integer <int32> (DashboardMaxDelayOverride)

Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn't change the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.
For individual charts, you can force the system to calculate a sensible value by removing the chart's maxDelayOverride property. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.

name
string (DashboardName)

A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.

selectedEventOverlays
Array of object (DashboardSelectedEventOverlaysArray)

Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.

tags
Array of string (Dashboard tags)

Array of dashboard tags. Reserved for future use.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "chartDensity": "DEFAULT\"",
  • "charts":
    [
    ],
  • "description": "string",
  • "eventOverlays":
    [
    ],
  • "filters":
    {
    },
  • "groupId": "string",
  • "maxDelayOverride": 0,
  • "name": "string",
  • "selectedEventOverlays":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "chartDensity": "DEFAULT\"",
  • "charts":
    [
    ],
  • "created": 0,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "discoveryOptions": { },
  • "eventOverlays":
    [
    ],
  • "filters":
    {
    },
  • "groupId": "string",
  • "id": "string",
  • "lastUpdated": 0,
  • "lastUpdatedBy": "string",
  • "locked": true,
  • "maxDelayOverride": 0,
  • "name": "string",
  • "selectedEventOverlays":
    [
    ],
  • "tags":
    [
    ]
}

Retrieve Dashboards Using Query

Retrieves dashboards based on search criteria

get /dashboard

SignalFx API endpoint.
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/dashboard

Retrieves one or more dashboard objects, based on query parameters you encode on the request URL. If you don't specify parameters, the request returns the first 50 objects that the user has access to, based on the user's access token specified in the request header. Query parameters also control the point in the result set at which the system starts returning objects, and the number of objects to return.

query Parameters
limit
integer <int32>

The maximum number of dashboard objects to return from the result set. If the value isn't valid, the system defaults to 50 objects.

name
string

Search string that the system compares to existing dashboard names. A match occurs if the string matches any part of the dashboard name. For example, the query specification name="per" matches the following (ellipses represent other parts of the name):

  • "...dropped per day..."
  • "...95th percentile"
  • "personal disk usage..."
    If you specify `name=""`, the system ignores the search string.
    The string must only contain ASCII characters.
offset
integer <int32>

0-based index of the point in the query result set where the system starts returning objects. If the offset value is greater than the size of the result set, you don't receive any results.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token, either an org token (referred to as an Access Token in the web UI) or a session token (referred to as a User API Access Token in the web UI). The organization or user must have permission to get the specified dashboards.

Responses

200

Successful retrieval of dashboard objects

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json; charset=utf8"

Format of the response payload.

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 UTC+0"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is UTC+0

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

X-Content-Type-Options
string
Default: "nosniff"

Indicates that front-end clients shouldn't attempt to determine the payload format and adjust the content-type to match their expectations.

Response Schema: application/json
count
integer <int32>

Number of dashboard objects that matched the provided search criteria.
Note: This value is a count of the total number of objects in the result set. The number of objects that the system returns is affected by the limit and offset query parameters. In summary:

  • count: Size of result set
  • number of returned objects:
    • (limit - offset) >= count: count
    • (limit - offset) < count: limit - offset
results
Array of object

Array of dashboard objects that the system returns as the result of the request. These objects represent dashboards that match the search query. The number and location of the objects within the result set depend on the query parameters you specify in the request. To learn more, see the top-level description of the API and the description of the count response property

Response samples

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

Retrieve Single Dashboard Using ID

Retrieves a dashboard specified in the {id} path parameter

get /dashboard/{id}

SignalFx API endpoint.
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/dashboard/{id}

Retrieves a dashboard object specified by the dashboard ID in the {id} path parameter. The response is a dashboard object.

path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token, either an org token (referred to as an Access Token in the web UI) or a session token (referred to as a User API Access Token in the web UI). The organization or user must have permission to get the specified dashboards.

Responses

200

Successful retrieval of a dashboard specification

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json; charset=utf8"

Format of the response payload.

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 UTC+0"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is UTC+0

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

X-Content-Type-Options
string
Default: "nosniff"

Indicates that front-end clients shouldn't attempt to determine the payload format and adjust the content-type to match their expectations.

Response Schema: application/json
authorizedWriters
object (Organizations and teams with write permission for an object)

If your organization has the "write permissions" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

chartDensity
string (DashboardChartDensity)
Default: "DEFAULT\\\""
Enum:"DEFAULT" "LOW" "HIGH" "HIGHEST"

Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:

  • DEFAULT maps to approximately 60 data points
  • LOW maps to approximately 30 data points
  • HIGH maps to approximately 120 data points
  • HIGHEST maps to approximately 240 data points
charts
Array of object (DashboardChartsArray)

Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.

created
integer <int64> (DashboardCreated)

The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.

creator
string (DashboardCreator)

SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is "AAAAAAAAAA". The system sets this value, and you can't modify it.

customProperties
object (DashboardCustomPropertiesObject)

Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:
Key:

  • ASCII characters only
  • Length <= 128 characters
  • Can only contain upper and lower case alphanumeric characters, underscores ("_"), and hyphens ("-")
  • Must start with an alphabetic character, upper or lower case.
  • Can't start with any of the following strings, which are reserved for system use: "", "sf", "aws_", or "gcp_".
    Value:
  • Must be present if you specify a key
  • Must not be empty
  • ASCII characters only
  • Length <= 256 characters
description
string (DashboardDescription)

Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.

discoveryOptions
object (DashboardDiscoveryOptionsObject)

Reserved for system use

eventOverlays
Array of object (DashboardEventOverlaysArray)

Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.
Note: The objects in this array correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.

filters
object (Filters to apply to all the charts of a dashboard)

Specifies the properties of filters to apply to the dashboard.
Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria.
You can also use filters to apply a custom time window to all of the charts in the dashboard.

groupId
string (DashboardGroupId)

ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.

id
string (DashboardId)

The dashboard's SignalFx-assigned ID. This value is "read-only" for a create request. The system assigns it and returns it to you in the response.

lastUpdated
integer <int64> (DashboardLastUpdated)

The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is "read-only".

lastUpdatedBy
string (DashboardLastUpdatedBy)

SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is "AAAAAAAAAA". This value is "read-only".

locked
boolean (DashboardLocked)

Flag that controls modification of the dashboard. If true, users can't modify the dashboard. If false, users that have authorization to access the dashboard can edit it.

maxDelayOverride
integer <int32> (DashboardMaxDelayOverride)

Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn't change the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.
For individual charts, you can force the system to calculate a sensible value by removing the chart's maxDelayOverride property. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.

name
string (DashboardName)

A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.

selectedEventOverlays
Array of object (DashboardSelectedEventOverlaysArray)

Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.

tags
Array of string (Dashboard tags)

Array of dashboard tags. Reserved for future use.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "chartDensity": "DEFAULT\"",
  • "charts":
    [
    ],
  • "created": 0,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "discoveryOptions": { },
  • "eventOverlays":
    [
    ],
  • "filters":
    {
    },
  • "groupId": "string",
  • "id": "string",
  • "lastUpdated": 0,
  • "lastUpdatedBy": "string",
  • "locked": true,
  • "maxDelayOverride": 0,
  • "name": "string",
  • "selectedEventOverlays":
    [
    ],
  • "tags":
    [
    ]
}

Update Single Dashboard

Updates a dashboard specified in the {id} path parameter

put /dashboard/{id}

SignalFx API endpoint.
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/dashboard/{id}

Updates the properties of the dashboard object specified by the ID in the {id} path parameter

path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token, either an org token (referred to as an Access Token in the web UI) or a session token (referred to as a User API Access Token in the web UI). The organization or user must have permission to get the specified dashboards.

Request Body schema: application/json
authorizedWriters
object (Organizations and teams with write permission for an object)

If your organization has the "write permissions" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

chartDensity
string (DashboardChartDensity)
Default: "DEFAULT\\\""
Enum:"DEFAULT" "LOW" "HIGH" "HIGHEST"

Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:

  • DEFAULT maps to approximately 60 data points
  • LOW maps to approximately 30 data points
  • HIGH maps to approximately 120 data points
  • HIGHEST maps to approximately 240 data points
charts
Array of object (DashboardChartsArray)

Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.

customProperties
object (DashboardCustomPropertiesObject)

Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:
Key:

  • ASCII characters only
  • Length <= 128 characters
  • Can only contain upper and lower case alphanumeric characters, underscores ("_"), and hyphens ("-")
  • Must start with an alphabetic character, upper or lower case.
  • Can't start with any of the following strings, which are reserved for system use: "", "sf", "aws_", or "gcp_".
    Value:
  • Must be present if you specify a key
  • Must not be empty
  • ASCII characters only
  • Length <= 256 characters
description
string (DashboardDescription)

Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.

eventOverlays
Array of object (DashboardEventOverlaysArray)

Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.
Note: The objects in this array correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.

filters
object (Filters to apply to all the charts of a dashboard)

Specifies the properties of filters to apply to the dashboard.
Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria.
You can also use filters to apply a custom time window to all of the charts in the dashboard.

groupId
string (DashboardGroupId)

ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.

maxDelayOverride
integer <int32> (DashboardMaxDelayOverride)

Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn't change the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.
For individual charts, you can force the system to calculate a sensible value by removing the chart's maxDelayOverride property. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.

name
string (DashboardName)

A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.

selectedEventOverlays
Array of object (DashboardSelectedEventOverlaysArray)

Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.

Responses

200

Successful update of the specified dashboard

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json; charset=utf8"

Format of the response payload.

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 UTC+0"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is UTC+0

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

X-Content-Type-Options
string
Default: "nosniff"

Indicates that front-end clients shouldn't attempt to determine the payload format and adjust the content-type to match their expectations.

Response Schema: application/json
authorizedWriters
object (Organizations and teams with write permission for an object)

If your organization has the "write permissions" feature enabled, you can use this object to specify the user and team IDs that have write access to the object you're specifying.

chartDensity
string (DashboardChartDensity)
Default: "DEFAULT\\\""
Enum:"DEFAULT" "LOW" "HIGH" "HIGHEST"

Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts:

  • DEFAULT maps to approximately 60 data points
  • LOW maps to approximately 30 data points
  • HIGH maps to approximately 120 data points
  • HIGHEST maps to approximately 240 data points
charts
Array of object (DashboardChartsArray)

Array of chart objects associated with the dashboard. Each chart object must exist and be unique across all dashboards.

created
integer <int64> (DashboardCreated)

The dashboard creation date and time, in the form of a Unix time value (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0). The system sets this value, and you can't modify it.

creator
string (DashboardCreator)

SignalFx-assigned user ID of the user that created the dashboard. If the system created this dashboard, the value is "AAAAAAAAAA". The system sets this value, and you can't modify it.

customProperties
object (DashboardCustomPropertiesObject)

Custom properties for the dashboard, in the form of a JSON object that contains key-value pairs. Custom properties must follow these syntax restrictions:
Key:

  • ASCII characters only
  • Length <= 128 characters
  • Can only contain upper and lower case alphanumeric characters, underscores ("_"), and hyphens ("-")
  • Must start with an alphabetic character, upper or lower case.
  • Can't start with any of the following strings, which are reserved for system use: "", "sf", "aws_", or "gcp_".
    Value:
  • Must be present if you specify a key
  • Must not be empty
  • ASCII characters only
  • Length <= 256 characters
description
string (DashboardDescription)

Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the web UI.

discoveryOptions
object (DashboardDiscoveryOptionsObject)

Reserved for system use

eventOverlays
Array of object (DashboardEventOverlaysArray)

Array of event overlay definitions that you can apply to all of the charts of this dashboard. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event.
Note: The objects in this array correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.

filters
object (Filters to apply to all the charts of a dashboard)

Specifies the properties of filters to apply to the dashboard.
Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria.
You can also use filters to apply a custom time window to all of the charts in the dashboard.

groupId
string (DashboardGroupId)

ID of an existing dashboard group to associate with this dashboard. If you don't specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.

id
string (DashboardId)

The dashboard's SignalFx-assigned ID. This value is "read-only" for a create request. The system assigns it and returns it to you in the response.

lastUpdated
integer <int64> (DashboardLastUpdated)

The last time the dashboard was updated, in the form of a Unix timestamp (milliseconds since the Unix epoch 1970-01-01 00:00:00 UTC+0) This value is "read-only".

lastUpdatedBy
string (DashboardLastUpdatedBy)

SignalFx-assigned ID of the last user who updated the dashboard. If the last update was by the system, the value is "AAAAAAAAAA". This value is "read-only".

locked
boolean (DashboardLocked)

Flag that controls modification of the dashboard. If true, users can't modify the dashboard. If false, users that have authorization to access the dashboard can edit it.

maxDelayOverride
integer <int32> (DashboardMaxDelayOverride)

Milliseconds to wait for late-arriving datapoints before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn't change the max delay setting for individua charts in the dashboard. If you omit this property, the system uses individual chart settings.
For individual charts, you can force the system to calculate a sensible value by removing the chart's maxDelayOverride property. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.

name
string (DashboardName)

A human-readable label for the dashboard. The web UI displays this label in the dashboard's group.

selectedEventOverlays
Array of object (DashboardSelectedEventOverlaysArray)

Array of event overlays that are currently active for the charts in this dashboard. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the the overlay's color and event line settings. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.

tags
Array of string (Dashboard tags)

Array of dashboard tags. Reserved for future use.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "chartDensity": "DEFAULT\"",
  • "charts":
    [
    ],
  • "customProperties": { },
  • "description": "string",
  • "eventOverlays":
    [
    ],
  • "filters":
    {
    },
  • "groupId": "string",
  • "maxDelayOverride": 0,
  • "name": "string",
  • "selectedEventOverlays":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "chartDensity": "DEFAULT\"",
  • "charts":
    [
    ],
  • "created": 0,
  • "creator": "string",
  • "customProperties": { },
  • "description": "string",
  • "discoveryOptions": { },
  • "eventOverlays":
    [
    ],
  • "filters":
    {