> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creditriskmonitor.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Benchmark Business Performance Against Peers
> Analyzes business metrics against industry peers using customizable parameters including SIC codes, risk levels, and geographic filters.
Please refer to the [**Data Fields**](/api-reference/datadictionary) page to review the fields available under different access models.
Use the [**Login** endpoint](/api-reference/user/logs-a-user-in) to retrieve the **`SessionKey`**, then include it in the **Authorization** field for authentication.
## OpenAPI
````yaml get /v1/Business/PeerAnalysis
openapi: 3.0.0
info:
version: v2
title: Credit Risk Monitor API
servers:
- url: https://api.creditriskmonitor.com
security: []
paths:
/v1/Business/PeerAnalysis:
get:
tags:
- Business
summary: Gets the Peer Analysis for a Business.
operationId: Business_GetBusinessPeerAnalysis
parameters:
- name: Year
in: query
description: Year to get data for
required: false
schema:
format: int32
type: integer
- name: Quarter
in: query
description: Quarter to get data for
required: false
schema:
format: int32
type: integer
- name: SICCode
in: query
description: SIC Code to filter by
required: false
schema:
type: string
- name: SICPrimary
in: query
description: >-
Filter by Primary SIC Code only or Primary and Secondary SIC Codes
(Y/N)
required: false
schema:
type: string
- name: FolderId
in: query
description: Portfolio FolderId
required: false
schema:
format: int32
type: integer
- name: TargetCountry
in: query
description: Two Letter country code
required: false
schema:
type: string
- name: RiskLevelFilter
in: query
description: >-
Risk Level (NS - Non-Scored / FS - Non-FRISK Scored / H1 - Risk
Level 1 / H2 - Risk Level 1 and 2 / H3 - Risk Level 1, 2 and 3 / H4
- Risk Level 1, 2, 3 and 4 / H5 - Risk Level 1, 2, 3, 4 and 5 / FS -
FRISK Scored / FH - FRISK High Risk / FM - FRISK Medium Risk / FL -
FRISK Low Risk / F1 - FRISK 1 (Highest Risk) / F2 - FRISK 2 / F3 -
FRISK 3 / F4 - FRISK 4 / F5 - FRISK 5 / F6 - FRISK 7 / F8 - FRISK 8
/ F9 - FRISK 9 / F10 - FRISK 10 (Lowest Risk))
required: false
schema:
type: string
- name: ZScoreFilter
in: query
description: >-
Filter by ZScore (N - Non Scored/ S - Scored / H - High Risk / M -
Medium Risk / L - Low Risk)
required: false
schema:
type: string
- name: PayceScoreFilter
in: query
description: >-
Filter by PAYCE Score (N - Non - PAYCE Scored / S - PAYCE Scored / H
- PAYCE Score High Risk / M - PAYCE Score Medium Risk / L - PAYCE
Score Low Risk)
required: false
schema:
type: string
- name: DBTFilter
in: query
description: >-
Filter by DBT (S - Scored Customers / N - Non-Scored Customers / D -
Delinquent / W - Slow / P - Prompt / 1 - (160+ days beyond terms) /
2 - (91 - 105 days beyond terms) / 3 - (76 - 90 days beyond terms) /
4 - (61 - 75 days beyond terms) / 5 - (46 - 60 days beyond terms) /
6 - (31 - 45 days beyond terms) / 7 - 2(1 - 30 days beyond terms) /
8 - (11 - 20 days beyond terms) / 9 - (0 - 10 days beyond terms) /
10 - (no past due balances for six periods))
required: false
schema:
type: string
- name: id
in: query
description: Business ID
required: false
schema:
format: int32
type: integer
- name: CustomerId
in: query
description: >-
If you are a Trade Provider you can use your CustomerId to idenfity
a Business with the CustomerId parameter.
required: false
schema:
type: string
- name: SupplierId
in: query
description: >-
If you have a Supplier List you can use your SupplierId to identify
a Business with the SupplierId parameter.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/APIResponseContainer_APIPeerAnalysis_'
text/json:
schema:
$ref: '#/components/schemas/APIResponseContainer_APIPeerAnalysis_'
text/html:
schema:
$ref: '#/components/schemas/APIResponseContainer_APIPeerAnalysis_'
application/xml:
schema:
$ref: '#/components/schemas/APIResponseContainer_APIPeerAnalysis_'
text/xml:
schema:
$ref: '#/components/schemas/APIResponseContainer_APIPeerAnalysis_'
security:
- Bearer: []
components:
schemas:
APIResponseContainer_APIPeerAnalysis_:
description: ''
type: object
properties:
Success:
description: ''
type: boolean
Data:
$ref: '#/components/schemas/APIPeerAnalysis'
ErrorCode:
description: ''
type: string
APIPeerAnalysis:
description: Peer Analysis
type: object
properties:
PeerYear:
format: int32
description: Year for this analysis
type: integer
PeerQuarter:
format: int32
description: Financial Quarters for this analysis
type: integer
SIC:
description: SIC Code for the Business
type: string
IndustryName:
description: Industry Code for the Business
type: string
PeerCount:
format: int32
description: Peer Count for the Business
type: integer
Ratios:
description: Peer Review Data
type: array
items:
$ref: '#/components/schemas/APIPeerRatio'
APIPeerRatio:
type: object
properties:
Ratio:
type: string
Value:
format: double
type: number
Max:
format: double
type: number
Min:
format: double
type: number
Median:
format: double
type: number
Count:
format: int32
type: integer
Rank:
format: int32
type: integer
securitySchemes:
Bearer:
type: http
scheme: bearer
description: >-
Enter the Session Key with the `Bearer ` prefix, e.g. "Bearer
abcde12345".
````