# Generate a report listing all usage of an algorithm on the masking engine

Endpoint: GET /algorithms/{algorithmName}/usage
Version: 5.1.43
Security: api_key

## Path parameters:

  - `algorithmName` (string, required)
    The name of the algorithm

## Query parameters:

  - `includeAssignmentDetail` (boolean, required)
    Whether to include extended, human-readable algorithm assignment detail in the report. File and mainframe format usages are expanded to show each usage across environments, rulesets and files. The content and ordering of these details are subject to change.

  - `excludeChainedAlgorithms` (boolean)
    Whether to exclude chained algorithm. This parameter will skip the computation of referencing algorithms

  - `environmentFilter` (array)
    Report only usage occurring within the specified environment(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any environment matching the filter. Filtering by environment excludes all domain and algorithm reference usage.

  - `rulesetFilter` (array)
    Report only usage occurring within the specified ruleset(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any ruleset matching the filter. Filtering by ruleset excludes all domain and algorithm reference usage.

## Response 200 fields (application/json):

  - `algorithmName` (string, required)
    The name of the algorithm to which this usage report applies.

  - `algorithmMaskingType` (string)
    The type of value this algorithm masks. This value is only available for algorithms based on the Algorithm Extensibility Framework.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER", "GENERIC_DATA_ROW", "ADVANCED_OBJECT"

  - `columnMetadataIds` (array)
    A list of the IDs of all columnMetadata objects that reference the algorithm.

  - `fileFieldMetadataIds` (array)
    A list of the IDs of all fileFieldMetadata objects that reference the algorithm.

  - `mainframeDatasetFieldMetadataIds` (array)
    A list of the IDs of all mainframeDatasetFieldMetadata objects that reference the algorithm.

  - `environmentIds` (array)
    A list of the IDs of all environments where the algorithm is used.

  - `rulesetIds` (array)
    A list of the IDs of all rulesets where the algorithm is used.

  - `domainNames` (array)
    A list of the names of all domains that reference the algorithm.

  - `algorithmReferences` (array)
    A list of the names of all other algorithms contain references to this algorithm.

  - `assignmentDetails` (array)
    A extended usage objects that describe the full path to each algorithm usage for all column, file and mainframe dataset assignments.

  - `assignmentDetails.assignmentType` (string, required)
    The type of algorithm usage.
    Enum: "DATABASE_COLUMN", "FILE_FIELD", "MAINFRAME_DATASET_FIELD"

  - `assignmentDetails.environmentName` (string)
    The environment where the algorithm usage occurs, if any. For file and dataset usage, this will return only one of potentially many environments where the file format referencing the algorithm is applied.

  - `assignmentDetails.databaseRulesetName` (string)
    The database ruleset where the algorithm usage occurs, if applicable.

  - `assignmentDetails.databaseTableName` (string)
    The database table where the algorithm usage occurs, if applicable.

  - `assignmentDetails.databaseColumnName` (string)
    The database column where the algorithm usage occurs, if applicable.

  - `assignmentDetails.fileRulesetName` (string)
    The name of the file ruleset where the algorithm usage occurs, if applicable.

  - `assignmentDetails.fileName` (string)
    The name of the file where the algorithm usage occurs, if applicable.

  - `assignmentDetails.fileFormatName` (string)
    The name of the file format where the algorithm usage occurs, if applicable.

  - `assignmentDetails.fileRecordTypeName` (string)
    The name of the file record type where the algorithm usage occurs, if applicable.

  - `assignmentDetails.fileFieldName` (string)
    The name of the file field where the algorithm usage occurs, if applicable

  - `assignmentDetails.mainframeDatasetRulesetName` (string)
    The name of the mainframe dataset ruleset where the algorithm usage occurs, if applicable.

  - `assignmentDetails.mainframeDatasetFileName` (string)
    The name of the mainframe dataset file where the algorithm usage occurs, if applicable.

  - `assignmentDetails.mainframeDatasetFormatName` (string)
    The name of the mainframe dataset format where the algorithm usage occurs, if applicable.

  - `assignmentDetails.mainframeDatasetRecordTypeName` (string)
    The name of the mainframe dataset record type where the algorithm usage occurs, if applicable.

  - `assignmentDetails.mainframeDatasetFieldName` (string)
    The name of t(he mainframe dataset field where the algorithm usage occurs, if applicable.


## Response 400 fields

## Response 401 fields

## Response 404 fields