API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve report data from your RQ database (v4.23 and up).

To get started, see Data Connect Guide.

Note

For reports that provide optional URI parameters for filtering at different levels (ForWho/ForWhoIDs/LocationType/LocationTypeIDs), omitting these values will run the report at the default company level.

Authentication

Data Connect supports many different methods of authentication, see Authentication Options.

Note that for all reports the Access Token should be mapped to an employee in RQ.

Report List

For a complete list of reports in Data Connect, see Report List.

ENDPOINTS

RESOURCES

GraphedPerformanceMetrixReportData

[
    {
        "ID": 6,
        "Name": "51247 Test_update",
        "AttachmentRate": "1249 : 2",
        "AttachmentRateTarget": "0 : 0",
        "DisplayFormat": 2,
        "IsAttachmentRate": true,
        "Margin": null,
        "MarginTarget": null,
        "Priority": -1,
        "Profit": null,
        "ProfitTarget": null,
        "Quantity": null,
        "QuantityTarget": null,
        "Sales": null,
        "SalesTarget": null
    }
]
Name Description
ID (INT) Identifier for a performance metrix group in RQ
Name (NVARCHAR(MAX)) Name of a performance metrix group in RQ
AttachmentRate (VARCHAR(23)) Comparison of Performance Groups for the Attachment Rate displayed as a ratio
AttachmentRateTarget (VARCHAR(23)) Attachment rate target
DisplayFormat (INT) 1: Ratio Format, 2: Percentage Format
IsAttachmentRate (BIT) A flag to indicate if performance group is an attachment rate
Margin (MONEY) Margin on sales in this performance group
MarginTarget (MONEY) Margin target
Priority (INT) Priority
Profit (MONEY) Net profit amount of sales in this performance group
ProfitTarget (MONEY) Profit target
Quantity (INT) Net count of SKUs sold in this performance group
QuantityTarget (INT) Quantity target
Sales (MONEY) Net dollar amount of sales in this performance group
SalesTarget (MONEY) Sales target

GraphedPerformanceMetrixBreakdownReportData

[
    {
        "ID": 1,
        "Name": "84 West",
        "GroupInvoiceCount": 839,
        "IsAttachmentRate": false,
        "Margin": -1691.5747,
        "MarginTarget": 0,
        "Profit": -45860859.08,
        "ProfitTarget": 0,
        "Quantity": 530,
        "QuantityTarget": 0,
        "Sales": 27111.34,
        "SalesTarget": 0,
        "TotalInvoiceCount": 2772
    }
]
Name Description
ID (INT) Internal idenfier in RQ
Name (NVARCHAR(MAX)) Name of company, region, division, location or employee depending on ByWho URL parameter
GroupInvoiceCount (INT) This number represents the size of the section of pie graph
IsAttachmentRate (BIT) A flag to indicate if performance group is an attachment rate
Margin (MONEY) Margin
MarginTarget (DECIMAL) Margin target
Profit (MONEY) Profit
ProfitTarget (MONEY) Profit target
Quantity (INT) Quantity
QuantityTarget (INT) Quantity target
Sales (MONEY) Total sales
SalesTarget (MONEY) Sales target
TotalInvoiceCount (INT) This number represents the total size of the graph

PerformanceMetrixReportData

[
    {
        "ID": 4,
        "Name": "Attachment Ratio",
        "Priority1": -1,
        "SearchDateQuantity": 0,
        "SearchDateSales": 0,
        "SearchDateProfit": 0,
        "SearchDateMargin": 0,
        "SearchDateAttachmentRate": "9 : 0",
        "Quantity": 0,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "QuantityPercentOfTarget": 0,
        "SalesPercentOfTarget": 0,
        "ProfitPercentOfTarget": 0,
        "MarginPercentOfTarget": 0,
        "QuantityTrending": 0,
        "SalesTrending": 0,
        "ProfitTrending": 0,
        "MarginTrending": 0,
        "QuantityTrendingPercentOfTarget": 0,
        "SalesTrendingPercentOfTarget": 0,
        "ProfitTrendingPercentOfTarget": 0,
        "MarginTrendingPercentOfTarget": 0,
        "QuantityTarget": 0,
        "SalesTarget": 0,
        "ProfitTarget": 0,
        "MarginTarget": 0,
        "AttachmentRateTarget": "0 : 0",
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]
Name Description
ID (INT) Internal identifier in RQ
Name (NVARCHAR(MAX)) Group - name of the group
Priority1 (INT) Internal value in RQ
SearchDateQuantity (MONEY) Quantity to Date - numeric and displays to nearest integer
SearchDateSales (MONEY) Sales to Date ($) - amount in dollars for sales to date
SearchDateProfit (MONEY) Profit to Date - numeric and displays to nearest integer
SearchDateMargin (DECIMAL) Margin to Date - numeric and displays to nearest integer
SearchDateAttachmentRate (VARCHAR(23)) Margin % of Target - percentage and displays Margin to date / target
Quantity (MONEY) Quantity Today - numeric and displays to nearest integer for today
Sales (MONEY) Today - numeric and displays to nearest integer for today
Profit (MONEY) Profit Today - numeric and displays to nearest integer for today
Margin (DECIMAL) Margin Today - numeric and displays to nearest integer for today
QuantityPercentOfTarget (DECIMAL) Quantity % of Target - percentage and displays Quantity to date / target
SalesPercentOfTarget (DECIMAL) Sales % of Target - percentage and displays sales to date / target
ProfitPercentOfTarget (DECIMAL) Profit % of Target - percentage and displays Profit to date / target
MarginPercentOfTarget (DECIMAL) Margin % of Target - percentage and displays Margin to date / target
QuantityTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Quantity To Date / (Date - beginning of period + 1)) * # of days in the period.
SalesTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Sales To Date / (Date - beginning of period + 1)) * # of days in the period.
ProfitTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Profit To Date / (Date - beginning of period + 1)) * # of days in the period.
MarginTrending (DECIMAL) Trending - numeric and displays to nearest integer. Formula is as follows: (Margin To Date / (Date - beginning of period + 1)) * # of days in the period.
QuantityTrendingPercentOfTarget (DECIMAL) Quantity % of Target - percentage and displays Quantity to date / target
SalesTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
ProfitTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
MarginTrendingPercentOfTarget (DECIMAL) Trending % of Target - percentage and displays trending / target
QuantityTarget (INT) Target - numeric and displays the target set in the Performance Targets Setup
SalesTarget (MONEY) Target - numeric and displays the target set in the Performance Targets Setup
ProfitTarget (MONEY) Target - numeric and displays the target set in the Performance Targets Setup
MarginTarget (DECIMAL) Target - numeric and displays the target set in the Performance Targets Setup
AttachmentRateTarget (VARCHAR(23)) Target - numeric and displays the target set in the Performance Targets Setup
IsAttachmentRate (BIT) Internal value in RQ
DisplayFormat (INT) Internal value in RQ
AttachmentRate (VARCHAR(23)) Rate - as calculated by the AR (PG1 divided by PG2)

PerformanceMetrixSummaryReportData

[
    {
        "GroupID": 5,
        "GroupName": "Accessories & Devices",
        "Priority": -1,
        "Quantity": 1,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "Enabled": 1,
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]
Name Description
GroupID (INT) Internal identifier in RQ
GroupName (NVARCHAR(MAX)) Group Name - name of the performance group
Priority (INT) Internal value in RQ
Quantity (INT) Quantity - net count of SKUs sold in this group for the search criteria
Sales (MONEY) Sales - net dollar amount of sales in this group for the search criteria
Profit (MONEY) Profit - net profit amount of sales in this group for the search criteria
Margin (DECIMAL) Margin - margin on the sales in this group for the search criteria
Enabled (INT) Internal value in RQ
IsAttachmentRate (BIT) Internal value in RQ
DisplayFormat (INT) Internal value in RQ
AttachmentRate (VARCHAR(23)) Rate - as calculated by the AR (PG1 divided by PG2)

REQUESTS

GET the Graphed Performance Metrix Report

For more information, see Graphed Performance Metrix Report.

Definition

GET /reports/graphedperformancemetricsreport_performancemetrix?PeriodID={PeriodID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&ForWho={ForWho}&ForWhoID={ForWhoID}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/graphedperformancemetricsreport_performancemetrix?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_performancemetrix?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGraphedPerformanceMetrixReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_performancemetrix?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheGraphedPerformanceMetrixReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_performancemetrix?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_performancemetrix?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GraphedPerformanceMetrixReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 6,
        "Name": "51247 Test_update",
        "AttachmentRate": "1249 : 2",
        "AttachmentRateTarget": "0 : 0",
        "DisplayFormat": 2,
        "IsAttachmentRate": true,
        "Margin": null,
        "MarginTarget": null,
        "Priority": -1,
        "Profit": null,
        "ProfitTarget": null,
        "Quantity": null,
        "QuantityTarget": null,
        "Sales": null,
        "SalesTarget": null
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 6,
            "Name": "51247 Test_update",
            "AttachmentRate": "1249 : 2",
            "AttachmentRateTarget": "0 : 0",
            "DisplayFormat": 2,
            "IsAttachmentRate": true,
            "Margin": null,
            "MarginTarget": null,
            "Priority": -1,
            "Profit": null,
            "ProfitTarget": null,
            "Quantity": null,
            "QuantityTarget": null,
            "Sales": null,
            "SalesTarget": null
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>6</ID>
    <Name>51247 Test_update</Name>
    <AttachmentRate>1249 : 2</AttachmentRate>
    <AttachmentRateTarget>0 : 0</AttachmentRateTarget>
    <DisplayFormat>2</DisplayFormat>
    <IsAttachmentRate>true</IsAttachmentRate>
    <Margin>null</Margin>
    <MarginTarget>null</MarginTarget>
    <Priority>-1</Priority>
    <Profit>null</Profit>
    <ProfitTarget>null</ProfitTarget>
    <Quantity>null</Quantity>
    <QuantityTarget>null</QuantityTarget>
    <Sales>null</Sales>
    <SalesTarget>null</SalesTarget>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
ID,Name,AttachmentRate,AttachmentRateTarget,DisplayFormat,IsAttachmentRate,Margin,MarginTarget,Priority,Profit,ProfitTarget,Quantity,QuantityTarget,Sales,SalesTarget
6,51247 Test_update,1249 : 2,0 : 0,2,true,null,null,-1,null,null,null,null,null,null

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Graphed Performance Metrix Breakdown Report

We reccomend using this request in combination with the Performance Metrix Report or Graphed Performance Metrix Report to retrieve a PerformanceGroupID.

For more information, see Graphed Performance Metrix Report.

Definition

GET /reports/graphedperformancemetricsreport_breakdown?PeriodID={PeriodID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&PerformanceGroupID={PerformanceGroupID}&TopN={TopN}&TopCriteria={TopCriteria}&ByWho={ByWho}&ForWho={ForWho}&ForWhoID={ForWhoID}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/graphedperformancemetricsreport_breakdown?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_breakdown?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGraphedPerformanceMetrixBreakdownReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_breakdown?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheGraphedPerformanceMetrixBreakdownReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_breakdown?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/graphedperformancemetricsreport_breakdown?PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoID=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GraphedPerformanceMetrixBreakdownReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 1,
        "Name": "84 West",
        "GroupInvoiceCount": 839,
        "IsAttachmentRate": false,
        "Margin": -1691.5747,
        "MarginTarget": 0,
        "Profit": -45860859.08,
        "ProfitTarget": 0,
        "Quantity": 530,
        "QuantityTarget": 0,
        "Sales": 27111.34,
        "SalesTarget": 0,
        "TotalInvoiceCount": 2772
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 1,
            "Name": "84 West",
            "GroupInvoiceCount": 839,
            "IsAttachmentRate": false,
            "Margin": -1691.5747,
            "MarginTarget": 0,
            "Profit": -45860859.08,
            "ProfitTarget": 0,
            "Quantity": 530,
            "QuantityTarget": 0,
            "Sales": 27111.34,
            "SalesTarget": 0,
            "TotalInvoiceCount": 2772
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>1</ID>
    <Name>84 West</Name>
    <GroupInvoiceCount>839</GroupInvoiceCount>
    <IsAttachmentRate>false</IsAttachmentRate>
    <Margin>-1691.5747</Margin>
    <MarginTarget>0</MarginTarget>
    <Profit>-45860859.08</Profit>
    <ProfitTarget>0</ProfitTarget>
    <Quantity>530</Quantity>
    <QuantityTarget>0</QuantityTarget>
    <Sales>27111.34</Sales>
    <SalesTarget>0</SalesTarget>
    <TotalInvoiceCount>2772</TotalInvoiceCount>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
ID,Name,GroupInvoiceCount,IsAttachmentRate,Margin,MarginTarget,Profit,ProfitTarget,Quantity,QuantityTarget,Sales,SalesTarget,TotalInvoiceCount
1,84 West,839,false,-1691.5747,0,-45860859.08,0,530,0,27111.34,0,2772

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Performance Metrix Report

For more information see Performance Metrix Report.

Definition

GET /reports/PerformanceMetrixReport?DateAsOf={DateAsOf}&HideRebates={HideRebates}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePerformanceMetrixReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingThePerformanceMetrixReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&HideRebates=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PerformanceMetrixReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 4,
        "Name": "Attachment Ratio",
        "Priority1": -1,
        "SearchDateQuantity": 0,
        "SearchDateSales": 0,
        "SearchDateProfit": 0,
        "SearchDateMargin": 0,
        "SearchDateAttachmentRate": "9 : 0",
        "Quantity": 0,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "QuantityPercentOfTarget": 0,
        "SalesPercentOfTarget": 0,
        "ProfitPercentOfTarget": 0,
        "MarginPercentOfTarget": 0,
        "QuantityTrending": 0,
        "SalesTrending": 0,
        "ProfitTrending": 0,
        "MarginTrending": 0,
        "QuantityTrendingPercentOfTarget": 0,
        "SalesTrendingPercentOfTarget": 0,
        "ProfitTrendingPercentOfTarget": 0,
        "MarginTrendingPercentOfTarget": 0,
        "QuantityTarget": 0,
        "SalesTarget": 0,
        "ProfitTarget": 0,
        "MarginTarget": 0,
        "AttachmentRateTarget": "0 : 0",
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 4,
            "Name": "Attachment Ratio",
            "Priority1": -1,
            "SearchDateQuantity": 0,
            "SearchDateSales": 0,
            "SearchDateProfit": 0,
            "SearchDateMargin": 0,
            "SearchDateAttachmentRate": "9 : 0",
            "Quantity": 0,
            "Sales": 0,
            "Profit": 0,
            "Margin": 0,
            "QuantityPercentOfTarget": 0,
            "SalesPercentOfTarget": 0,
            "ProfitPercentOfTarget": 0,
            "MarginPercentOfTarget": 0,
            "QuantityTrending": 0,
            "SalesTrending": 0,
            "ProfitTrending": 0,
            "MarginTrending": 0,
            "QuantityTrendingPercentOfTarget": 0,
            "SalesTrendingPercentOfTarget": 0,
            "ProfitTrendingPercentOfTarget": 0,
            "MarginTrendingPercentOfTarget": 0,
            "QuantityTarget": 0,
            "SalesTarget": 0,
            "ProfitTarget": 0,
            "MarginTarget": 0,
            "AttachmentRateTarget": "0 : 0",
            "IsAttachmentRate": true,
            "DisplayFormat": 2,
            "AttachmentRate": "114 : 0"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>4</ID>
    <Name>Attachment Ratio</Name>
    <Priority1>-1</Priority1>
    <SearchDateQuantity>0</SearchDateQuantity>
    <SearchDateSales>0</SearchDateSales>
    <SearchDateProfit>0</SearchDateProfit>
    <SearchDateMargin>0</SearchDateMargin>
    <SearchDateAttachmentRate>9 : 0</SearchDateAttachmentRate>
    <Quantity>0</Quantity>
    <Sales>0</Sales>
    <Profit>0</Profit>
    <Margin>0</Margin>
    <QuantityPercentOfTarget>0</QuantityPercentOfTarget>
    <SalesPercentOfTarget>0</SalesPercentOfTarget>
    <ProfitPercentOfTarget>0</ProfitPercentOfTarget>
    <MarginPercentOfTarget>0</MarginPercentOfTarget>
    <QuantityTrending>0</QuantityTrending>
    <SalesTrending>0</SalesTrending>
    <ProfitTrending>0</ProfitTrending>
    <MarginTrending>0</MarginTrending>
    <QuantityTrendingPercentOfTarget>0</QuantityTrendingPercentOfTarget>
    <SalesTrendingPercentOfTarget>0</SalesTrendingPercentOfTarget>
    <ProfitTrendingPercentOfTarget>0</ProfitTrendingPercentOfTarget>
    <MarginTrendingPercentOfTarget>0</MarginTrendingPercentOfTarget>
    <QuantityTarget>0</QuantityTarget>
    <SalesTarget>0</SalesTarget>
    <ProfitTarget>0</ProfitTarget>
    <MarginTarget>0</MarginTarget>
    <AttachmentRateTarget>0 : 0</AttachmentRateTarget>
    <IsAttachmentRate>true</IsAttachmentRate>
    <DisplayFormat>2</DisplayFormat>
    <AttachmentRate>114 : 0</AttachmentRate>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
ID,Name,Priority1,SearchDateQuantity,SearchDateSales,SearchDateProfit,SearchDateMargin,SearchDateAttachmentRate,Quantity,Sales,Profit,Margin,QuantityPercentOfTarget,SalesPercentOfTarget,ProfitPercentOfTarget,MarginPercentOfTarget,QuantityTrending,SalesTrending,ProfitTrending,MarginTrending,QuantityTrendingPercentOfTarget,SalesTrendingPercentOfTarget,ProfitTrendingPercentOfTarget,MarginTrendingPercentOfTarget,QuantityTarget,SalesTarget,ProfitTarget,MarginTarget,AttachmentRateTarget,IsAttachmentRate,DisplayFormat,AttachmentRate
4,Attachment Ratio,-1,0,0,0,0,9 : 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 : 0,true,2,114 : 0

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Performance Group Report

For more information see Performance Group Report.

Definition

GET /reports/PerformanceMetrixReport?DateAsOf={DateAsOf}&PerformanceGroupID={PerformanceGroupID}&TopN={TopN}&TopCriteria={TopCriteria}&ByWho={ByWho}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePerformanceGroupReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingThePerformanceGroupReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixReport?DateAsOf=2016-01-01T06:00:00.000Z&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PerformanceMetrixReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 4,
        "Name": "Attachment Ratio",
        "Priority1": -1,
        "SearchDateQuantity": 0,
        "SearchDateSales": 0,
        "SearchDateProfit": 0,
        "SearchDateMargin": 0,
        "SearchDateAttachmentRate": "9 : 0",
        "Quantity": 0,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "QuantityPercentOfTarget": 0,
        "SalesPercentOfTarget": 0,
        "ProfitPercentOfTarget": 0,
        "MarginPercentOfTarget": 0,
        "QuantityTrending": 0,
        "SalesTrending": 0,
        "ProfitTrending": 0,
        "MarginTrending": 0,
        "QuantityTrendingPercentOfTarget": 0,
        "SalesTrendingPercentOfTarget": 0,
        "ProfitTrendingPercentOfTarget": 0,
        "MarginTrendingPercentOfTarget": 0,
        "QuantityTarget": 0,
        "SalesTarget": 0,
        "ProfitTarget": 0,
        "MarginTarget": 0,
        "AttachmentRateTarget": "0 : 0",
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 4,
            "Name": "Attachment Ratio",
            "Priority1": -1,
            "SearchDateQuantity": 0,
            "SearchDateSales": 0,
            "SearchDateProfit": 0,
            "SearchDateMargin": 0,
            "SearchDateAttachmentRate": "9 : 0",
            "Quantity": 0,
            "Sales": 0,
            "Profit": 0,
            "Margin": 0,
            "QuantityPercentOfTarget": 0,
            "SalesPercentOfTarget": 0,
            "ProfitPercentOfTarget": 0,
            "MarginPercentOfTarget": 0,
            "QuantityTrending": 0,
            "SalesTrending": 0,
            "ProfitTrending": 0,
            "MarginTrending": 0,
            "QuantityTrendingPercentOfTarget": 0,
            "SalesTrendingPercentOfTarget": 0,
            "ProfitTrendingPercentOfTarget": 0,
            "MarginTrendingPercentOfTarget": 0,
            "QuantityTarget": 0,
            "SalesTarget": 0,
            "ProfitTarget": 0,
            "MarginTarget": 0,
            "AttachmentRateTarget": "0 : 0",
            "IsAttachmentRate": true,
            "DisplayFormat": 2,
            "AttachmentRate": "114 : 0"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>4</ID>
    <Name>Attachment Ratio</Name>
    <Priority1>-1</Priority1>
    <SearchDateQuantity>0</SearchDateQuantity>
    <SearchDateSales>0</SearchDateSales>
    <SearchDateProfit>0</SearchDateProfit>
    <SearchDateMargin>0</SearchDateMargin>
    <SearchDateAttachmentRate>9 : 0</SearchDateAttachmentRate>
    <Quantity>0</Quantity>
    <Sales>0</Sales>
    <Profit>0</Profit>
    <Margin>0</Margin>
    <QuantityPercentOfTarget>0</QuantityPercentOfTarget>
    <SalesPercentOfTarget>0</SalesPercentOfTarget>
    <ProfitPercentOfTarget>0</ProfitPercentOfTarget>
    <MarginPercentOfTarget>0</MarginPercentOfTarget>
    <QuantityTrending>0</QuantityTrending>
    <SalesTrending>0</SalesTrending>
    <ProfitTrending>0</ProfitTrending>
    <MarginTrending>0</MarginTrending>
    <QuantityTrendingPercentOfTarget>0</QuantityTrendingPercentOfTarget>
    <SalesTrendingPercentOfTarget>0</SalesTrendingPercentOfTarget>
    <ProfitTrendingPercentOfTarget>0</ProfitTrendingPercentOfTarget>
    <MarginTrendingPercentOfTarget>0</MarginTrendingPercentOfTarget>
    <QuantityTarget>0</QuantityTarget>
    <SalesTarget>0</SalesTarget>
    <ProfitTarget>0</ProfitTarget>
    <MarginTarget>0</MarginTarget>
    <AttachmentRateTarget>0 : 0</AttachmentRateTarget>
    <IsAttachmentRate>true</IsAttachmentRate>
    <DisplayFormat>2</DisplayFormat>
    <AttachmentRate>114 : 0</AttachmentRate>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
ID,Name,Priority1,SearchDateQuantity,SearchDateSales,SearchDateProfit,SearchDateMargin,SearchDateAttachmentRate,Quantity,Sales,Profit,Margin,QuantityPercentOfTarget,SalesPercentOfTarget,ProfitPercentOfTarget,MarginPercentOfTarget,QuantityTrending,SalesTrending,ProfitTrending,MarginTrending,QuantityTrendingPercentOfTarget,SalesTrendingPercentOfTarget,ProfitTrendingPercentOfTarget,MarginTrendingPercentOfTarget,QuantityTarget,SalesTarget,ProfitTarget,MarginTarget,AttachmentRateTarget,IsAttachmentRate,DisplayFormat,AttachmentRate
4,Attachment Ratio,-1,0,0,0,0,9 : 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 : 0,true,2,114 : 0

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Performance Metrix Summary Report

For more information see Performance Metrix Summary Report.

Definition

GET /reports/PerformanceMetrixSummaryReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&ReportType={ReportType}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/PerformanceMetrixSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePerformanceMetrixSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingThePerformanceMetrixSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/PerformanceMetrixSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&HideRebates=-1&ReportType=Group&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PerformanceMetrixSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GroupID": 5,
        "GroupName": "Accessories & Devices",
        "Priority": -1,
        "Quantity": 1,
        "Sales": 0,
        "Profit": 0,
        "Margin": 0,
        "Enabled": 1,
        "IsAttachmentRate": true,
        "DisplayFormat": 2,
        "AttachmentRate": "114 : 0"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GroupID": 5,
            "GroupName": "Accessories & Devices",
            "Priority": -1,
            "Quantity": 1,
            "Sales": 0,
            "Profit": 0,
            "Margin": 0,
            "Enabled": 1,
            "IsAttachmentRate": true,
            "DisplayFormat": 2,
            "AttachmentRate": "114 : 0"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GroupID>5</GroupID>
    <GroupName>Accessories & Devices</GroupName>
    <Priority>-1</Priority>
    <Quantity>1</Quantity>
    <Sales>0</Sales>
    <Profit>0</Profit>
    <Margin>0</Margin>
    <Enabled>1</Enabled>
    <IsAttachmentRate>true</IsAttachmentRate>
    <DisplayFormat>2</DisplayFormat>
    <AttachmentRate>114 : 0</AttachmentRate>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
GroupID,GroupName,Priority,Quantity,Sales,Profit,Margin,Enabled,IsAttachmentRate,DisplayFormat,AttachmentRate
5,Accessories & Devices,-1,1,0,0,0,1,true,2,114 : 0

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?