Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
description: REST API for ChartHop
version: V1.0.0
title: ChartHop access Metric API
contact:
name: ChartHop
url: https://www.charthop.com
email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: metric
paths:
/v1/org/{orgId}/metric:
post:
tags:
- metric
summary: Record a daily metric
operationId: recordMetric
parameters:
- name: orgId
in: path
description: Org identifier (either id or slug)
required: true
schema:
type: string
responses:
'400':
description: bad request
'401':
description: not authorized
'404':
description: not found
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordMetricRequest'
required: true
components:
schemas:
RecordMetricRequest:
type: object
required:
- metric
- value
properties:
metric:
type: string
description: the name of the metric, for example kpi.revenue.arr
value:
type: number
description: the numeric value of the metric
date:
type: string
format: date
description: the date that the metric applies to (if blank, will default to today)