Trendsic Platform Service

<back to all web services

ExecutiveDashboardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dashboards/executive
ExecutiveDashboardRequest Parameters:
NameParameterData TypeRequiredDescription
PeriodquerystringNo
RegionquerystringNo
Fyqueryint?No
ExecutiveDashboardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DashboardformExecutiveDashboardNo
ExecutiveDashboard Parameters:
NameParameterData TypeRequiredDescription
PeriodformstringNo
FromDateformDateTimeNo
ToDateformDateTimeNo
FyformintNo
KpisformList<ExecKpi>No
CostVsBillingformList<ExecCostCategory>No
MonthlyformList<ExecMonthPoint>No
BacklogformExecBacklogNo
WipformList<ExecWipRow>No
PipelineformList<ExecPipelineStage>No
WinRatePctformdoubleNo
ReceivablesformList<ExecAgingBucket>No
RetainageUSDformdoubleNo
DsoDaysformintNo
SafetyformList<ExecSafetyMetric>No
ExecKpi Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
ValueformstringNo
Sub_formstringNo
DeltaformstringNo
DeltaUpformboolNo
HasDeltaformboolNo
GoodformboolNo
ExecCostCategory Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
CostUSDformdoubleNo
BilledUSDformdoubleNo
ExecMonthPoint Parameters:
NameParameterData TypeRequiredDescription
MonthformstringNo
RevenueUSDformdoubleNo
CostUSDformdoubleNo
ExecBacklog Parameters:
NameParameterData TypeRequiredDescription
TotalUSDformdoubleNo
MonthsAheadformdoubleNo
AwardsYtdUSDformdoubleNo
BurnYtdUSDformdoubleNo
ByYearformList<ExecBacklogYear>No
ExecBacklogYear Parameters:
NameParameterData TypeRequiredDescription
YearformstringNo
ValueUSDformdoubleNo
ExecWipRow Parameters:
NameParameterData TypeRequiredDescription
ContractIdformintNo
NameformstringNo
OwnerformstringNo
ValueUSDformdoubleNo
PctCompleteformdoubleNo
BilledUSDformdoubleNo
OverUnderUSDformdoubleNo
MarginPctformdoubleNo
FadePtsformdoubleNo
ExecPipelineStage Parameters:
NameParameterData TypeRequiredDescription
StageformstringNo
ValueUSDformdoubleNo
CountformintNo
ExecAgingBucket Parameters:
NameParameterData TypeRequiredDescription
BucketformstringNo
AmountUSDformdoubleNo
IsRetainageformboolNo
ExecSafetyMetric Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformstringNo
Sub_formstringNo
GoodformboolNo

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.

GET /v1/dashboards/executive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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"}},"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}]}}