Graphite Render API

Contents

With the Graphite Render API, you can:

  • View raw metric data outside of your primary dashboards.

  • Apply functions to your metric data.

  • Search for data within a specific or relative time frame.

  • Retrieve the data in different display formats.

  • Use Graphite Access Keys to integrate metric data into external tools or services.

Render endpoint

GET /YOUR-UID/ACCESS-KEY/graphite/render?target=

To integrate Hosted Graphite data externally, Create an Access Key to authorize render requests. Copy the key URL and add /render?target=

Path Parameters

Name
Type
Description

target*

String

from/to

String

These parameters accept relative or absolute times (or both). Relative Time is the length of time from the current time and is always preceded by a minus sign (-). If no time parameters are specified, the default values are from=now-24h and to=now.

&format=png

String

Renders a graph as a 330×250 px png (default option, if the &format parameter is left unspecified).

&format=svg

String

Renders a graph as a 330×250 px svg.

&format=raw

String

Line-delimited output. (target, start timestamp, end timestamp, step, data)

&format=csv

String

Creates a CSV file to download (metric, date/time, value)

&format=json

String

Returns a JSON object.

The accepted units of time are:

Abbreviation
Unit

s

Seconds

min

Minutes

h

Hours

d

Days

w

Weeks

mon

Month (30 Days)

y

Year (365 Days)

Using the sample metric foo.bar, below are some example queries and outputs:

https://www.hostedgraphite.com/YOUR-UID/ACCESS-KEY/graphite/render?target=foo.bar&from=now-30min
https://www.hostedgraphite.com/YOUR-UID/ACCESS-KEY/graphite/render?target=alias(foo.bar,"Uptime")&from=now-30min
https://www.hostedgraphite.com/YOUR-UID/ACCESS-KEY/graphite/render?target=foo.bar&from=now-30min&format=json

Curl Example:

curl -X GET "https://www.hostedgraphite.com/YOUR-UID/ACCESS-KEY/graphite/render?target=foo.bar&from=now-30min&format=json"

For more information about building queries and customizing outputs, visit the Graphite Render Docs.

Last updated