> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# relativity-review

> Relativity Review - audit trails and statistics

**Server path:** `/relativity-review` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                            | Description                                 |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [`relativity_review_download_audit_export`](#relativity_review_download_audit_export)           | \[Public] IAuditExportService -             |
| [`relativity_review_get_audit_dump_status`](#relativity_review_get_audit_dump_status)           | \[Public] IAuditDumpService -               |
| [`relativity_review_get_audit_export_status`](#relativity_review_get_audit_export_status)       | \[Public] IAuditExportService -             |
| [`relativity_review_get_audit_metrics`](#relativity_review_get_audit_metrics)                   | \[Public] IAuditMetricsService -            |
| [`relativity_review_get_document_action_counts`](#relativity_review_get_document_action_counts) | \[Public] IAuditReviewerStatisticsService - |
| [`relativity_review_get_reviewer_choices`](#relativity_review_get_reviewer_choices)             | \[Public] IAuditReviewerStatisticsService - |
| [`relativity_review_get_reviewer_stats`](#relativity_review_get_reviewer_stats)                 | \[Public] IAuditReviewerStatisticsService - |
| [`relativity_review_get_usage_times`](#relativity_review_get_usage_times)                       | \[Public] IAuditReviewerStatisticsService - |
| [`relativity_review_pivot_audits`](#relativity_review_pivot_audits)                             | \[Public] IAuditPivotService -              |
| [`relativity_review_query_audits`](#relativity_review_query_audits)                             | \[Public] IAuditQueryService -              |
| [`relativity_review_schedule_audit_dump`](#relativity_review_schedule_audit_dump)               | \[Public] IAuditDumpService -               |
| [`relativity_review_submit_audit_export`](#relativity_review_submit_audit_export)               | \[Public] IAuditExportService -             |

***

## relativity\_review\_download\_audit\_export

\[Public] IAuditExportService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `request`       | object  | No       | —       | The request value       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "request": {
        "type": "object",
        "description": "The request value",
        "properties": {
          "JobId": {
            "type": "string",
            "description": "Job Id"
          },
          "FileType": {
            "type": "string",
            "description": "File Type"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_audit\_dump\_status

\[Public] IAuditDumpService -

**Parameters:**

| Parameter       | Type   | Required | Default | Description             |
| --------------- | ------ | -------- | ------- | ----------------------- |
| `jobID`         | string | Yes      | —       | Job ID                  |
| `x-csrf-header` | string | Yes      | —       | The x-csrf-header value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "jobID": {
        "type": "string",
        "description": "Job ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      }
    },
    "required": [
      "PCID",
      "jobID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_audit\_export\_status

\[Public] IAuditExportService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `jobID`         | string  | Yes      | —       | Job ID                  |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "jobID": {
        "type": "string",
        "description": "Job ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "jobID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_audit\_metrics

\[Public] IAuditMetricsService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_document\_action\_counts

\[Public] IAuditReviewerStatisticsService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `criteria`      | object  | No       | —       | The criteria value      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "criteria": {
        "type": "object",
        "description": "The criteria value",
        "properties": {
          "AuditActionIDs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Audit Action I Ds"
          },
          "UserIDs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "User I Ds"
          },
          "StartDate": {
            "type": "object",
            "description": "Start date for filtering"
          },
          "EndDate": {
            "type": "object",
            "description": "End date for filtering"
          },
          "TimeZone": {
            "type": "string",
            "description": "Timezone identifier"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_reviewer\_choices

\[Public] IAuditReviewerStatisticsService -

**Parameters:**

| Parameter                 | Type    | Required | Default | Description               |
| ------------------------- | ------- | -------- | ------- | ------------------------- |
| `workspaceID`             | integer | Yes      | —       | Workspace ID              |
| `x-csrf-header`           | string  | Yes      | —       | The x-csrf-header value   |
| `reviewerChoicesCriteria` | object  | No       | —       | Reviewer Choices Criteria |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "reviewerChoicesCriteria": {
        "type": "object",
        "description": "Reviewer Choices Criteria",
        "properties": {
          "FieldIDs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Field I Ds"
          },
          "EndDate": {
            "type": "object",
            "description": "End date for filtering"
          },
          "StartDate": {
            "type": "object",
            "description": "Start date for filtering"
          },
          "TimeZone": {
            "type": "string",
            "description": "Timezone identifier"
          },
          "UserIdsToIncludeInReport": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "User Ids To Include In Report"
          },
          "UserIdsToExcludeInReport": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "User Ids To Exclude In Report"
          },
          "SavedSearchId": {
            "type": "integer",
            "description": "Saved Search Id"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_reviewer\_stats

\[Public] IAuditReviewerStatisticsService -

**Parameters:**

| Parameter                  | Type    | Required | Default | Description                 |
| -------------------------- | ------- | -------- | ------- | --------------------------- |
| `workspaceID`              | integer | Yes      | —       | Workspace ID                |
| `x-csrf-header`            | string  | Yes      | —       | The x-csrf-header value     |
| `reviewerStatsDataRequest` | object  | No       | —       | Reviewer Stats Data Request |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "reviewerStatsDataRequest": {
        "type": "object",
        "description": "Reviewer Stats Data Request",
        "properties": {
          "StartDate": {
            "type": "string",
            "description": "Start date for filtering"
          },
          "EndDate": {
            "type": "string",
            "description": "End date for filtering"
          },
          "TimeZone": {
            "type": "number",
            "description": "Timezone identifier"
          },
          "DownTimeThreshold": {
            "type": "integer",
            "description": "Down Time Threshold"
          },
          "NonAdmin": {
            "type": "boolean",
            "description": "Non Admin"
          },
          "AdditionalActions": {
            "type": "string",
            "description": "Additional Actions"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_get\_usage\_times

\[Public] IAuditReviewerStatisticsService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `criteria`      | object  | No       | —       | The criteria value      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "criteria": {
        "type": "object",
        "description": "The criteria value",
        "properties": {
          "AuditActionIDs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "Audit Action I Ds"
          },
          "DownTimeThresholdSeconds": {
            "type": "integer",
            "description": "Down Time Threshold Seconds"
          },
          "UserIDs": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "description": "User I Ds"
          },
          "StartDate": {
            "type": "object",
            "description": "Start date for filtering"
          },
          "EndDate": {
            "type": "object",
            "description": "End date for filtering"
          },
          "TimeZone": {
            "type": "string",
            "description": "Timezone identifier"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_pivot\_audits

\[Public] IAuditPivotService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `cancel`        | object  | No       | —       | The cancel value        |
| `progress`      | object  | No       | —       | The progress value      |
| `settings`      | object  | No       | —       | The settings value      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "cancel": {
        "type": "object",
        "description": "The cancel value",
        "properties": {
          "None": {
            "type": "object",
            "description": "Circular schema reference: #/components/schemas/CancellationToken"
          },
          "IsCancellationRequested": {
            "type": "boolean",
            "description": "Is Cancellation Requested"
          },
          "CanBeCanceled": {
            "type": "boolean",
            "description": "Can Be Canceled"
          },
          "WaitHandle": {
            "type": "object",
            "description": "Wait Handle"
          }
        }
      },
      "progress": {
        "type": "object",
        "description": "The progress value"
      },
      "settings": {
        "type": "object",
        "description": "The settings value",
        "properties": {
          "ObjectSetQuery": {
            "type": "object",
            "description": "Object Set Query"
          },
          "ArtifactTypeID": {
            "type": "integer",
            "description": "Artifact Type ID"
          },
          "GroupBy": {
            "type": "object",
            "description": "Group By"
          },
          "PivotOn": {
            "type": "object",
            "description": "Pivot On"
          },
          "GroupByDateGrouping": {
            "type": "string",
            "description": "Group By Date Grouping",
            "enum": [
              "Date",
              "Month",
              "Year",
              "YearMonth",
              "Week",
              "TwoWeeks"
            ]
          },
          "PivotOnDateGrouping": {
            "type": "string",
            "description": "Pivot On Date Grouping",
            "enum": [
              "Date",
              "Month",
              "Year",
              "YearMonth",
              "Week",
              "TwoWeeks"
            ]
          },
          "MaximumNumberOfColumns": {
            "type": "integer",
            "description": "Maximum Number Of Columns"
          },
          "MaximumNumberOfRows": {
            "type": "integer",
            "description": "Maximum Number Of Rows"
          },
          "Timeout": {
            "type": "integer",
            "description": "The timeout value"
          },
          "RawDataOnly": {
            "type": "boolean",
            "description": "Raw Data Only"
          },
          "TimeZone": {
            "type": "string",
            "description": "Timezone identifier"
          },
          "ConvertNumberFieldValuesToString": {
            "type": "boolean",
            "description": "Convert Number Field Values To String"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_query\_audits

\[Public] IAuditQueryService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `request`       | object  | No       | —       | The request value       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "request": {
        "type": "object",
        "description": "The request value",
        "properties": {
          "ID": {
            "type": "string",
            "description": "The id value"
          },
          "Timestamp": {
            "type": "string",
            "description": "The timestamp value"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_schedule\_audit\_dump

\[Public] IAuditDumpService -

**Parameters:**

| Parameter       | Type   | Required | Default | Description             |
| --------------- | ------ | -------- | ------- | ----------------------- |
| `x-csrf-header` | string | Yes      | —       | The x-csrf-header value |
| `dumpRequest`   | object | No       | —       | Dump Request            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "dumpRequest": {
        "type": "object",
        "description": "Dump Request",
        "properties": {
          "WorkspaceID": {
            "type": "integer",
            "description": "Workspace ID"
          },
          "Fields": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The fields value"
          },
          "StartDate": {
            "type": "string",
            "description": "Start date for filtering"
          },
          "EndDate": {
            "type": "string",
            "description": "End date for filtering"
          },
          "Condition": {
            "type": "string",
            "description": "The condition value"
          }
        }
      }
    },
    "required": [
      "PCID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>

***

## relativity\_review\_submit\_audit\_export

\[Public] IAuditExportService -

**Parameters:**

| Parameter       | Type    | Required | Default | Description             |
| --------------- | ------- | -------- | ------- | ----------------------- |
| `workspaceID`   | integer | Yes      | —       | Workspace ID            |
| `x-csrf-header` | string  | Yes      | —       | The x-csrf-header value |
| `request`       | object  | No       | —       | The request value       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "integer",
        "description": "Workspace ID"
      },
      "x-csrf-header": {
        "type": "string",
        "description": "The x-csrf-header value"
      },
      "request": {
        "type": "object",
        "description": "The request value",
        "properties": {
          "PathUrl": {
            "type": "string",
            "description": "Path Url"
          },
          "FileType": {
            "type": "string",
            "description": "File Type"
          }
        }
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "x-csrf-header"
    ]
  }
  ```
</Expandable>