| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/report/run |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DatasetCode | form | string | No | |
| Dimensions | form | List<string> | No | |
| Measures | form | List<ReportMeasure> | No | |
| Joins | form | List<string> | No | |
| Filters | form | string | No | |
| Sorts | form | List<ReportSort> | No | |
| Limit | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldCode | form | string | No | |
| Agg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldCode | form | string | No | |
| Dir | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | ReportRunResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Columns | form | List<ReportColumnMeta> | No | |
| Rows | form | List<Dictionary<String,Object>> | No | |
| RowCount | form | int | No | |
| Truncated | form | bool | No | |
| Notes | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| DataType | form | string | No | |
| FieldKind | form | string | No | |
| Agg | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
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"]}}