POST api/salesanalysistool/getSATGraphs
Request Information
URI Parameters
None.
Body Parameters
SATCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| LOCNCODE | string |
None. |
|
| Segment | string |
None. |
|
| ReportGroup | string |
None. |
|
| RepID | string |
None. |
|
| Partnership | string |
None. |
|
| Customer | string |
None. |
|
| Category | string |
None. |
|
| Item | string |
None. |
|
| Class | string |
None. |
|
| Vendor | string |
None. |
|
| Type | string |
None. |
|
| ExcludeZZs | boolean |
None. |
|
| BeginDate | date |
None. |
|
| EndDate | date |
None. |
|
| GroupByField | string |
None. |
|
| SearchFor | string |
None. |
|
| PagingStart | integer |
None. |
|
| NumRecs | integer |
None. |
|
| SortFieldName | string |
None. |
|
| SortDirection | string |
None. |
|
| UserName | string |
None. |
|
| SATView | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"LOCNCODE": "sample string 1",
"Segment": "sample string 2",
"ReportGroup": "sample string 3",
"RepID": "sample string 4",
"Partnership": "sample string 5",
"Customer": "sample string 6",
"Category": "sample string 7",
"Item": "sample string 8",
"Class": "sample string 9",
"Vendor": "sample string 10",
"Type": "sample string 11",
"ExcludeZZs": true,
"BeginDate": "2026-11-21T14:52:59.1864912+00:00",
"EndDate": "2026-11-21T14:52:59.1864912+00:00",
"GroupByField": "sample string 15",
"SearchFor": "sample string 16",
"PagingStart": 1,
"NumRecs": 1,
"SortFieldName": "sample string 17",
"SortDirection": "sample string 18",
"UserName": "sample string 19",
"SATView": "sample string 20"
}
application/xml, text/xml
Sample:
<SATCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models"> <BeginDate>2026-11-21T14:52:59.1864912+00:00</BeginDate> <Category>sample string 7</Category> <Class>sample string 9</Class> <Customer>sample string 6</Customer> <EndDate>2026-11-21T14:52:59.1864912+00:00</EndDate> <ExcludeZZs>true</ExcludeZZs> <GroupByField>sample string 15</GroupByField> <Item>sample string 8</Item> <LOCNCODE>sample string 1</LOCNCODE> <NumRecs>1</NumRecs> <PagingStart>1</PagingStart> <Partnership>sample string 5</Partnership> <RepID>sample string 4</RepID> <ReportGroup>sample string 3</ReportGroup> <SATView>sample string 20</SATView> <SearchFor>sample string 16</SearchFor> <Segment>sample string 2</Segment> <SortDirection>sample string 18</SortDirection> <SortFieldName>sample string 17</SortFieldName> <Type>sample string 11</Type> <UserName>sample string 19</UserName> <Vendor>sample string 10</Vendor> </SATCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of SalesAnalysisSummary| Name | Description | Type | Additional information |
|---|---|---|---|
| RowGroup | string |
None. |
|
| TotalCurrCost | decimal number |
None. |
|
| TotalCurrSales | decimal number |
None. |
|
| TotalPrior1Cost | decimal number |
None. |
|
| TotalPrior1Sales | decimal number |
None. |
|
| TotalPrior2Cost | decimal number |
None. |
|
| TotalPrior2Sales | decimal number |
None. |
|
| CurrMargin | decimal number |
None. |
|
| CurrMargPerc | decimal number |
None. |
|
| Prior1Margin | decimal number |
None. |
|
| Prior1MargPerc | decimal number |
None. |
|
| Prior2Margin | decimal number |
None. |
|
| Prior2MargPerc | decimal number |
None. |
|
| NumRecords | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"RowGroup": "sample string 1",
"TotalCurrCost": 2.1,
"TotalCurrSales": 3.1,
"TotalPrior1Cost": 4.1,
"TotalPrior1Sales": 5.1,
"TotalPrior2Cost": 6.1,
"TotalPrior2Sales": 7.1,
"CurrMargin": 8.1,
"CurrMargPerc": 32.26,
"Prior1Margin": 10.1,
"Prior1MargPerc": 19.61,
"Prior2Margin": 12.1,
"Prior2MargPerc": 14.08,
"NumRecords": 14
},
{
"RowGroup": "sample string 1",
"TotalCurrCost": 2.1,
"TotalCurrSales": 3.1,
"TotalPrior1Cost": 4.1,
"TotalPrior1Sales": 5.1,
"TotalPrior2Cost": 6.1,
"TotalPrior2Sales": 7.1,
"CurrMargin": 8.1,
"CurrMargPerc": 32.26,
"Prior1Margin": 10.1,
"Prior1MargPerc": 19.61,
"Prior2Margin": 12.1,
"Prior2MargPerc": 14.08,
"NumRecords": 14
}
]
application/xml, text/xml
Sample:
<ArrayOfSalesAnalysisSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<SalesAnalysisSummary>
<CurrMargPerc>32.26</CurrMargPerc>
<CurrMargin>8.1</CurrMargin>
<NumRecords>14</NumRecords>
<Prior1MargPerc>19.61</Prior1MargPerc>
<Prior1Margin>10.1</Prior1Margin>
<Prior2MargPerc>14.08</Prior2MargPerc>
<Prior2Margin>12.1</Prior2Margin>
<RowGroup>sample string 1</RowGroup>
<TotalCurrCost>2.1</TotalCurrCost>
<TotalCurrSales>3.1</TotalCurrSales>
<TotalPrior1Cost>4.1</TotalPrior1Cost>
<TotalPrior1Sales>5.1</TotalPrior1Sales>
<TotalPrior2Cost>6.1</TotalPrior2Cost>
<TotalPrior2Sales>7.1</TotalPrior2Sales>
</SalesAnalysisSummary>
<SalesAnalysisSummary>
<CurrMargPerc>32.26</CurrMargPerc>
<CurrMargin>8.1</CurrMargin>
<NumRecords>14</NumRecords>
<Prior1MargPerc>19.61</Prior1MargPerc>
<Prior1Margin>10.1</Prior1Margin>
<Prior2MargPerc>14.08</Prior2MargPerc>
<Prior2Margin>12.1</Prior2Margin>
<RowGroup>sample string 1</RowGroup>
<TotalCurrCost>2.1</TotalCurrCost>
<TotalCurrSales>3.1</TotalCurrSales>
<TotalPrior1Cost>4.1</TotalPrior1Cost>
<TotalPrior1Sales>5.1</TotalPrior1Sales>
<TotalPrior2Cost>6.1</TotalPrior2Cost>
<TotalPrior2Sales>7.1</TotalPrior2Sales>
</SalesAnalysisSummary>
</ArrayOfSalesAnalysisSummary>