Skip to content

Key Metrics

Retrieve key metrics points for a company

🚧 Access Limitation Notice:

The Company Insights Cards API endpoint is only available for entities that have been validated and uniquely identified by our curation team. This ensures high-quality, accurate insights about your companies of interest.

Notes

  • For all endpoints requiring a company ID, make sure it's URL encoded when passed as a query parameter
  • The resourceId format looks like: nlp/f/entity/gz:org:openai
  • When URL encoded it becomes: nlp%2Ff%2Fentity%2Fgz%3Aorg%3Aopenai

OpenAPI definition

json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ML Endpoint",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.feedly.com/v3/ml"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/insight-cards/key-data-points": {
      "get": {
        "summary": "Key Metrics",
        "description": "Retrieve key metrics points for a company",
        "operationId": "key-metrics",
        "parameters": [
          {
            "name": "resourceId",
            "in": "query",
            "description": "resourceId (must be URL encoded)",
            "required": true,
            "schema": {
              "type": "string",
              "default": "nlp%2Ff%2Fentity%2Fgz%3Aorg%3Aopenai"
            }
          },
          {
            "name": "lastNDays",
            "in": "query",
            "description": "Last number of days (IE: 365)",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 365
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "660334c44e14a80012542b9a:67a63fdc8d394d000f2a6cfc"
}