| GET,OPTIONS | /v1/dashboards/executive |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Period | query | string | No | |
| Region | query | string | No | |
| Fy | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Dashboard | form | ExecutiveDashboard | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Period | form | string | No | |
| FromDate | form | DateTime | No | |
| ToDate | form | DateTime | No | |
| Fy | form | int | No | |
| Kpis | form | List<ExecKpi> | No | |
| CostVsBilling | form | List<ExecCostCategory> | No | |
| Monthly | form | List<ExecMonthPoint> | No | |
| Backlog | form | ExecBacklog | No | |
| Wip | form | List<ExecWipRow> | No | |
| Pipeline | form | List<ExecPipelineStage> | No | |
| WinRatePct | form | double | No | |
| Receivables | form | List<ExecAgingBucket> | No | |
| RetainageUSD | form | double | No | |
| DsoDays | form | int | No | |
| Safety | form | List<ExecSafetyMetric> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Label | form | string | No | |
| Value | form | string | No | |
| Sub_ | form | string | No | |
| Delta | form | string | No | |
| DeltaUp | form | bool | No | |
| HasDelta | form | bool | No | |
| Good | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| CostUSD | form | double | No | |
| BilledUSD | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Month | form | string | No | |
| RevenueUSD | form | double | No | |
| CostUSD | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalUSD | form | double | No | |
| MonthsAhead | form | double | No | |
| AwardsYtdUSD | form | double | No | |
| BurnYtdUSD | form | double | No | |
| ByYear | form | List<ExecBacklogYear> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Year | form | string | No | |
| ValueUSD | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContractId | form | int | No | |
| Name | form | string | No | |
| Owner | form | string | No | |
| ValueUSD | form | double | No | |
| PctComplete | form | double | No | |
| BilledUSD | form | double | No | |
| OverUnderUSD | form | double | No | |
| MarginPct | form | double | No | |
| FadePts | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stage | form | string | No | |
| ValueUSD | form | double | No | |
| Count | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bucket | form | string | No | |
| AmountUSD | form | double | No | |
| IsRetainage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| Value | form | string | No | |
| Sub_ | form | string | No | |
| Good | form | bool | 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.
GET /v1/dashboards/executive HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsonl
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"}},"Dashboard":{"Period":"String","FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","Fy":0,"Kpis":[{"Key":"String","Label":"String","Value":"String","Sub_":"String","Delta":"String","DeltaUp":false,"HasDelta":false,"Good":false}],"CostVsBilling":[{"Name":"String","CostUSD":0,"BilledUSD":0}],"Monthly":[{"Month":"String","RevenueUSD":0,"CostUSD":0}],"Backlog":{"TotalUSD":0,"MonthsAhead":0,"AwardsYtdUSD":0,"BurnYtdUSD":0,"ByYear":[{"Year":"String","ValueUSD":0}]},"Wip":[{"ContractId":0,"Name":"String","Owner":"String","ValueUSD":0,"PctComplete":0,"BilledUSD":0,"OverUnderUSD":0,"MarginPct":0,"FadePts":0}],"Pipeline":[{"Stage":"String","ValueUSD":0,"Count":0}],"WinRatePct":0,"Receivables":[{"Bucket":"String","AmountUSD":0,"IsRetainage":false}],"RetainageUSD":0,"DsoDays":0,"Safety":[{"Label":"String","Value":"String","Sub_":"String","Good":false}]}}