---
title: "submit request to generate external arr metrics"
method: POST
path: "/metricsReporting/externalArrMetrics"
tags: ["MetricsReporting"]
---

# submit request to generate external arr metrics

`POST /metricsReporting/externalArrMetrics`

## Request

- Base URL: `https://api.app.subskribe.com`
- URL: `https://api.app.subskribe.com/metricsReporting/externalArrMetrics`
- Auth: API key in header `X-API-Key`

returns the request with its captured id. Arr metrics will be generated as a backend job

## Request body

- ExternalArrScheduleJson
  - `id` string
  - `externalId` string
  - `startDate` integer, required
  - `endDate` integer, required
  - `category` 'OPENING_BALANCE' | 'NEW' | 'ADD_ON' | 'RENEWAL_ADD_ON' | 'UPSELL' | 'MARKUP' | 'RENEWAL_UPSELL' | 'RENEWAL_MARKUP' | 'DOWNSELL' | 'MARKDOWN' | 'RENEWAL_DOWNSELL' | 'RENEWAL_MARKDOWN' | 'TERMINATION' | 'EXPIRATION' | 'PENDING_RENEWAL' | 'REACTIVATION' | 'DEBOOK'
  - `amount` number, required
  - `quantity` integer, required
  - `previousScheduleId` string
  - `metadata` string
  - `submittedBy` string

## Response `default`

successful operation

---

[API](https://skmtc.dev/dealhub/apis/subskribe-api.md) - [All operations](https://skmtc.dev/dealhub/apis/subskribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dealhub/apis/subskribe-api/revisions/c1ee531b82ce?raw)