Trendsic Platform Service

AgreementKpiRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/agreements

**AgreementKpiRequest** Parameters:
Name	Parameter	Data Type	Required
FromDate	body	DateTime	No
ToDate	body	DateTime	No
LocationIds	body	List<Guid>	No

**AgreementKpiResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Stats	form	List<DashboardStatTile>	No
ByBranch	form	List<AgreementKpiBranchRow>	No

**DashboardStatTile** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Value	form	double	No
PreviousValue	form	double?	No
Unit	form	string	No
DeltaPct	form	double?	No

**AgreementKpiBranchRow** Parameters:
Name	Parameter	Data Type	Required
BranchName	form	string	No
ActiveCount	form	int	No
Mrr	form	double	No
ExpiringCount	form	int	No
ChurnCount	form	int	No
SkippedRate	form	double	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/dashboard/agreements HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Stats":[{"Key":"String","Label":"String","Value":0,"PreviousValue":0,"Unit":"String","DeltaPct":null}],"ByBranch":[{"BranchName":"String","ActiveCount":0,"Mrr":0,"ExpiringCount":0,"ChurnCount":0,"SkippedRate":0}]}