Export signals

Method for exporting signals using a structured request.

The signals will be exported for the union of entities given by the tags and entities. At least one entity or one tag must be provided. Uses the same response format as Export signal groups.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
signals
array of objects
required

Signals to export. At least one of label or expression must be provided per signal. The label will be used as column header if provided. If expression is not provided, the label must refer to a derived signal in the library.

signals*
entities
array of strings

Entities to export the signals for, represented by resource names.

entities
tags
array of strings

Static or dynamic tags to export signals for, represented by resource names.

tags
timeRange
object
required

A time range represented by two google.protobuf.Timestamps.

date-time

The version to retrieve data at. If empty, the end of time is used.

string
enum

Cross-sectional aggregation method.

  • SUM: Sum aggregation.
  • MEAN: Mean aggregation.
  • MEDIAN: Median aggregation.
  • PROPORTION: Calculates the ratio of each time series against the total.
  • RANK_ASCENDING: Ranks the values in ascending order.
  • RANK_DESCENDING: Ranks the values in descending order.
Allowed:
string
enum
required

File format to return.

  • csv
  • excel: .xlsx format
  • pickle: pickled pandas DataFrame
  • json
  • feather
  • parquet
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/octet-stream