Developer Relationships

Beautiful, personalized, interactive developer hubs.

Get Started

Try a free trial with all the features!

Docs

API Logs

Metrics

Try It!

v2.2GuideReferenceChangelog

Try It

curl --request GET
  --url https://dash.readme.io/api/v1/docs/api-metrics-in-readme
  --header 'authorization: Basic <<apiKey>>'

200

{
  "title": "API Metrics in ReadMe"
  "type": "basic"
  "slug": "api-metrics-in-readme"
  "body": "[block:api-header] { "title": "Documentation + API Metrics = 💜" } [/block] So you've put in a lot..."
  "body_html": "<div class="magic-block-api-header"> <h1 class="header-scroll is-api-header"><span id="documentatio..."
  "isReference": false
  "hidden": false
  "link_external": false
  "pendingAlgoliaPublish": false
  "slugUpdatedAt": "2020-09-02T20:39:15.481Z"
  "_id": "5e41dd0bda10a10011f286f8"
  "version": "5e1a4f2f4adda30040c91939"
  "project": "5e1a4f2f4adda30040c91b27"
  "category": "5e1a4f2f4adda30040c919af"
  "updatedAt": "2020-09-03T17:39:34.632Z"
  "createdAt": "2020-02-10T19:42:45.730Z"
  "__v": 1
  "isApi": false
}

Try working API examples right from the reference.

Users will automatically see their own individual API key that they can use with your API.

Try It!

304

301

300

400

401

200

201

204

Get Developer Metrics.

Track how customers use your API and provide more personalized support.

Metrics

404

"error": "DOC_NOTFOUND",
"message": "The doc with the slug 'hello-world' couldn't be found",
"suggestion": "Make sure you have the slug correct! It should look something like 'getting-started'. Slugs can be changed, so it's possible someone moved it!",
"docs": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f",
"help": "If you need help, email support@readme.io and include the following link to your API log: 'https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f'.",

Doing the right thing when things go wrong.

When your users get errors, don’t make them hunt for a fix. You can generate a link for each error message.

View API Logs Error