SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Dashboard Groups API

Dashboard groups let you collect dashboards with common characteristics in one place in the web UI, so you can view them together or in sequence.

Dashboard group membership

A dashboard can belong to only one dashboard group, but a group can contain multiple dashboards. However, user default dashboard groups can only contain the user's default dashboard.
When you create a new dashboard group, the system generates a new dashboard for it. Similarly, when you create a new dashboard, the system creates a new dashboard group for it. Because a dashboard can only belong to one group, you can't add existing dashboards to a new group (the dashboards already belong to a group). To add an existing dashboard to a new group, create the group and then change the dashboard group of the dashboards to the new group.
You can add a new dashboard to an existing group at any time.

Cloning dashboards into different groups

You can also clone existing dashboards into another group. Use this feature to test dashboards in your user dashboard group before cloning them into a production group. You can also use this feature to customize an existing dashboard, by cloning it into your user group and then modifying it.

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.

Permissions required

Your ability to make the aforementioned changes are limited by the permissions you have for the original dashboard and the mirror's dashboard group:
* If you have write permission for the original dashboard, you can change any aspect of the mirrored dashboard, and these changes appear in the original.

  • If you have write permission for the dashboard group that contains the mirrored dashboard, you can apply limited overrides to the mirror.
  • In all other cases, you can't change the mirrored dashboard.

    Mirrored dashboard overrides

    With the proper permissions, you can override the following dashboard settings:
    • Dashboard name
    • Dashboard description
    • Dashboard filters
    • Dashboard variables
      By default, these settings are the same as those of the original dashboard.

      Deleting mirrored dashboards

      If you've created mirrored dashboards from a dashboard, you can't delete the original until you've deleted all of its mirrored dashboards.

Dashboard membership tracking

The dashboard group ID for a dashboard is stored in the dashboard's object, but the system uses the dashboard IDs stored in the dashboard group object to track a group's dashboards.

Deleting dashboard groups

When you delete a dashboard group, the system deletes the dashboards in the group and the charts that those dashboards contain.
Note: The system doesn't do this for dashboards. When you delete a dashboard, the system orphans its charts, but it doesn't delete them.
You can assign a dashboard group to one or more teams in your organization. The groups then appear on the team's landing page in the web UI.

Viewing a dashboard group

To view a dashboard group you create using the API, navigate to the following URL:
https://app.<REALM>.signalfx.com/#/dashboard/<GROUP_ID>
For <GROUP_ID>, substitute the value of the dashboard group ID. In the web UI, you see the dashboard group name, and underneath it the dashboard names displayed as tabs.

Dashboard group authorizations

By default, all users can edit or delete dashboard groups. If your organization has the "write permissions" feature enabled, your administrator can limit editing and deletion of specific dashboard groups to individual users or teams or both. This feature helps prevent unauthorized or accidental modifications to dashboard groups. Administrators can always modify write permissions, even for dashboard groups which they don't have permission to edit. This lets administrators escalate their access for any dashboard group. When a user deletes a dashboard group, the system deletes the group's dashboards without regard to the dashboard permissions. Only the dashgroup group permissions are considered.

Create Single Dashboard Group

Creates a dashboard group

post /dashboardgroup

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/dashboardgroup

Creates a dashboard group 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 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.

dashboards
Array of string (Array of dashboards to add to the dashboardgroup)

Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.

description
string (DashboardGroupDescription)

Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.

name
required
string (DashboardGroupName) non-empty

Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.

teams
any (DashboardGroupTeamsArray)

Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.

Responses

200

Successful creation of the dashboard group

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.

created
integer <int64> (DashboardGroupCreated)

The dashboard group 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 (DashboardGroupCreator)

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

dashboards
Array of string (Array of dashboards to add to the dashboardgroup)

Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.

description
string (DashboardGroupDescription)

Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.

id
string (DashboardGroupId)

The SignalFx-assigned ID for this dashboard.

lastUpdated
integer <int64> (DashboardGroupLastUpdated)

The last time the dashboard group 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 (DashboardGroupLastUpdatedBy)

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

name
string (DashboardGroupName) non-empty

Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.

teams
any (DashboardGroupTeamsArray)

Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "dashboards":
    [
    ],
  • "description": "string",
  • "name": "string",
  • "teams": null
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "created": 0,
  • "creator": "string",
  • "dashboards":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "lastUpdated": 0,
  • "lastUpdatedBy": "string",
  • "name": "string",
  • "teams": null
}

Retrieve Dashboard Groups Using Query

Gets dashboard groups based on search criteria

get /dashboardgroup

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/dashboardgroup

Retrieves the specification of a dashboard group (a dashboard group object) 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 group 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 group names. A match occurs if the string matches any part of the 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 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).

Responses

200

Successful retrieval of dashboard groups.
Note: If the system fails to find any dashboard groups that satisfy the query parameters, it returns HTTP status code 200 with an empty response body.

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 group 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 group objects that the system returns as the result of the request. These objects represent dashboard groups 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 Dashboard Group Using ID

Gets a single dashboard group specified in the {id} path parameter

get /dashboardgroup/{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/dashboardgroup/{id}

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

path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard group.

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 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).

Responses

200

Successful retrieval of the dashboard group object specified in by the {id} path parameter

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.

created
integer <int64> (DashboardGroupCreated)

The dashboard group 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 (DashboardGroupCreator)

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

dashboards
Array of string (Array of dashboards to add to the dashboardgroup)

Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.

description
string (DashboardGroupDescription)

Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.

id
string (DashboardGroupId)

The SignalFx-assigned ID for this dashboard.

lastUpdated
integer <int64> (DashboardGroupLastUpdated)

The last time the dashboard group 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 (DashboardGroupLastUpdatedBy)

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

name
string (DashboardGroupName) non-empty

Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.

teams
any (DashboardGroupTeamsArray)

Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "created": 0,
  • "creator": "string",
  • "dashboards":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "lastUpdated": 0,
  • "lastUpdatedBy": "string",
  • "name": "string",
  • "teams": null
}

Update Single Dashboard Group

Updates a single dashboard group specified in the {id} path parameter

put /dashboardgroup/{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/dashboardgroup/{id}

Updates the dashboard group specified by the {id} path parameter, using the properties specified in the request body.
This API does a full update. The system removes or resets properties that you don't specify in the request body. In particular, if you're updating the dashboard group to add dashboards, you must include all of the dashboards that currently belong to the group, otherwise the system removes them.
Use this operation to add a mirrored dashboard to the group

path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard group.

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 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.

dashboards
Array of string (Array of dashboards to add to the dashboardgroup)

Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.

description
string (DashboardGroupDescription)

Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.

name
string (DashboardGroupName) non-empty

Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.

teams
any (DashboardGroupTeamsArray)

Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.

Responses

200

Successful retrieval of a dashboard group object based on its ID.

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.

created
integer <int64> (DashboardGroupCreated)

The dashboard group 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 (DashboardGroupCreator)

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

dashboards
Array of string (Array of dashboards to add to the dashboardgroup)

Array of dashboard IDs. The system adds the specified dashboards to the dashboard group you're creating. If you omit the property, the system creates a new dashboard and assigns it to the new dashboard group.

description
string (DashboardGroupDescription)

Description of the dashboard group. This value appears in the tooltip for the dashboard group on the Dashboards page in the web UI.

id
string (DashboardGroupId)

The SignalFx-assigned ID for this dashboard.

lastUpdated
integer <int64> (DashboardGroupLastUpdated)

The last time the dashboard group 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 (DashboardGroupLastUpdatedBy)

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

name
string (DashboardGroupName) non-empty

Name of the dashboard group. This value identifies the dashboard group in the web UI. It appears on the dashboards page and in the catalog. It also appears at the top left corner of the screen whenever you're viewing a dashboard that the group contains.

teams
any (DashboardGroupTeamsArray)

Array of existing team object ID. The dashboard group appears on the team landing page for any team in the list.

Request samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "dashboards":
    [
    ],
  • "description": "string",
  • "name": "string",
  • "teams": null
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "authorizedWriters":
    {
    },
  • "created": 0,
  • "creator": "string",
  • "dashboards":
    [
    ],
  • "description": "string",
  • "id": "string",
  • "lastUpdated": 0,
  • "lastUpdatedBy": "string",
  • "name": "string",
  • "teams": null
}

Delete Single Dashboard Group

Deletes a single dashboard group specified in the {id} path parameter

delete /dashboardgroup/{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/dashboardgroup/{id}

Deletes the dashboard group specified by the {id} path parameter.
Deleting the group also deletes the dashboards it contains and the charts that the deleted dashboards contain. If you want to keep the dashboards and charts:

  1. Update the dashboard group to remove the dashboards you want to keep.
  2. Update the dashboards to remove the group ID from them.
  3. Delete the dashboard group.
path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard group.

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 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).

Responses

200

Successful deletion of the specified dashboard group

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.

Clone Dashboard to Group

Clones an existing dashboard into another dashboard group specified in the {id} path parameter

post /dashboardgroup/{id}/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/dashboardgroup/{id}/dashboard

Clone Dashboard to Dashboard Group creates a new v2 dashboard from an existing dashboard and adds it to the dashboard group specified by the {id} path parameter. The new dashboard object is an exact copy of the existing dashboard, but you can override the name, description, and filters for the cloned copy by specifying the values in the request payload.

Dashboard types you can clone

You can clone any dashboard, including built-in dashboards and user-specific dashboards.

Using dashboard cloning

When you test or develop dashboards in your user-specific dashboard group, deploy them to production by calling Clone Dashboard to Dashboard Group. Similarly, if you want to customize a built-in dashboard to better suit your own needs, clone it to your user dashboard group and then modify the result.

Authorization

If you clone a dashboard to a dashboard group, and you don't have authorization to modify the dashboard, the system removes the existing permissions for the dashboard so that all users can modify it. However, you must have authorization to modify the dashboard group into which you're cloning the dashboard.

path Parameters
id
required
string

The SignalFx-assigned ID of an existing dashboard group.

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 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
description
string

Updated description of the cloned dashboard. If you omit this property, the system uses the description of the source dashboard

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

Specifies the properties of filters to apply to the cloned dashboard.
This is an optional property that you only need to use if you want to override the filters property of the dashboard you're cloning. 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.

name
string (DashboardName)

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

sourceDashboard
required
string (Dashboard ID of a cloned dashboard)

The ID of the dashboard to clone into the dashboard group whose ID is specified in the {id} path parameter

Responses

200

Successful copy of a dashboard into another dashboard group

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
id
string

SignalFx-assigned ID of the new dashboard.

Request samples

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

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string"
}

© Copyright 2019 SignalFx.

Third-party license information