Trendsic Platform Service

<back to all web services

ReportRunRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/report/run
ReportDefinition Parameters:
NameParameterData TypeRequiredDescription
DatasetCodeformstringNo
DimensionsformList<string>No
MeasuresformList<ReportMeasure>No
JoinsformList<string>No
FiltersformstringNo
SortsformList<ReportSort>No
LimitformintNo
ReportMeasure Parameters:
NameParameterData TypeRequiredDescription
FieldCodeformstringNo
AggformstringNo
ReportSort Parameters:
NameParameterData TypeRequiredDescription
FieldCodeformstringNo
DirformstringNo
ReportRunResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformReportRunResultNo
ReportRunResult Parameters:
NameParameterData TypeRequiredDescription
ColumnsformList<ReportColumnMeta>No
RowsformList<Dictionary<String,Object>>No
RowCountformintNo
TruncatedformboolNo
NotesformList<string>No
ReportColumnMeta Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
DataTypeformstringNo
FieldKindformstringNo
AggformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/report/run HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DatasetCode":"String","Dimensions":["String"],"Measures":[{"FieldCode":"String","Agg":"String"}],"Joins":["String"],"Filters":"String","Sorts":[{"FieldCode":"String","Dir":"String"}],"Limit":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":{"Columns":[{"Code":"String","Name":"String","DataType":"String","FieldKind":"String","Agg":"String"}],"Rows":[{"String":{}}],"RowCount":0,"Truncated":false,"Notes":["String"]}}