Visible API

Mikhail Topolskiy • visible
Help

Apiary Powered Documentation

Sign in with Apiary account.

Visible API

Introduction

The Visible API allows retrieving and updating metrics in visible.vc.

Schema

All API access is over HTTPS and accessed from https://api.visible.vc. All data is sent and received as JSON.

All timestamps and dates are returned in ISO 8601 format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SSZ

Auth

Each API request must include an access token in the Authorization HTTP header:

Authorization: Bearer c92dfc786b31...31c005332467

A token is issued to a specific Visible user and will have access to the same companies the user does.

To obtain an access token contact us at dev@visible.vc.

Rate Limiting

You can make up to 300 API requests in a 5 minute window, this limit might change in the future. If the limit is exceeded the API will return a 429 Too Many Requests HTTP header.

Reference

Metrics

List Metrics

Returns a paginated collection of metrics.

URI Parameters
company_idid of your company or fund
pagepage number
filter

filter by portfolio company profile id with filter[portfolio_company_profile_id]=ec5252fe-9abc-4096-85e9-1374e70a3182 (Investor product only)

Create a Metric

Request
object
  • name
    string, required
  • frequency
    enum, required[string, fixed]
  • unit
    enum, required[string, fixed]
  • company_id
    string, required
    c85cb869-40c0-4b8f-829a-30cdeb673ce0

Data points

Data points store the actual value of a metric for each time period.

List Data points

Returns a paginated collection of data points for a metric.

URI Parameters
metric_idid of a metric
pagepage number

Upsert Data points

Create or update multiple data points for a metric (limited to up to 50 data points per request).

If you don't know the metric's id you can get it from the metric's URL in the app: https://app.visible.vc/companies/{company_id}/data/metrics/{metric_id}.

URI Parameters
metric_idid of the metric
Request
object
  • date
    string, required
    2019-01-01
  • value
    number, required
    10.99

Contacts

Create a Contact

Create contacts in your Visible account.

If you don't know your company id you can get it from the URL in the app: https://app.visible.vc/companies/{company_id}.

Request
object
  • email
    string, required
    test@example.com
  • company_id
    string, required
    c85cb869-40c0-4b8f-829a-30cdeb673ce0
  • first_name
    string
    Jane
  • last_name
    string
    Doe
  • title
    string
    CEO
  • contact_list_ids
    array[string]

Contact lists

List Contact lists

Returns a paginated collection of contact lists.

URI Parameters
company_idid of your company or fund
pagepage number

Portfolio company profiles

Investor product only

A portfolio company profile represents a single company in your Portfolio section.

List Portfolio company profiles

Returns a paginated collection of portfolio company profiles.

URI Parameters
company_idid of your company or fund
pagepage number