Insights

Get one metric from the insights bundle

get/companies/{companyId}/insights/metrics/{metricKey}

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/insights/metrics/{metricKey}
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Concrete authorized legal entity for Intelligence metrics, briefs, and Ask history. Omission is accepted only when the actor is authorized to exactly one concrete entity; consolidated scope is not supported.

period'last_30_days' | 'last_90_days' | 'month_to_date'
startDatestring date
endDatestring date
industrystring

Response

Insight metric

successboolean

Example response

{
  "data": {
    "series": [
      {
        "annotations": [
          {
            "message": "Numbers are still settling — your accountant is working on it"
          }
        ]
      }
    ],
    "qualityFlags": [
      {
        "message": "Numbers are still settling — your accountant is working on it"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.