Public
Documentation Settings
Environment Variables
Double Column
cURL - cURL
Visualizer.coffee API
Introduction
GET
Get public shots
GET
Get my shots
POST
Upload shot
GET
Get shot data
GET
Get shot profile
GET
Get shared shot

Visualizer.coffee API

Use this postman collection if you want to have a look at the data stored on https://visualizer.coffee created by https://github.com/miharekar.

Here's the code/api on GitHub
https://github.com/miharekar/decent-visualizer

GETGet public shots

https://visualizer.coffee/api/shots/?page=1&items=10

Get a (paginated) list of public shots.

PARAMS
page

1

(optional) Requested page number (default = 1)

items

10

(optional) The size of your page (max = 100, default = 10).

Example Request
Get public shots
curl
curl --location 'https://visualizer.coffee/api/shots/?page=1&items=10'
200 OK
Example Response
json
{
  "data": [
    {
      "clock": 1636157618,
      "id": "b6966bcd-2e0c-484f-8ebf-02647d4f5f6f"
    },
    {
      "clock": 1636123988,
      "id": "4131040f-bcf5-433a-a559-3b3b8400840e"
    },
    {
      "clock": 1636123763,
      "id": "9cc9ee2d-ce2f-44d1-b0f2-e785b5e01717"
    },
    {
      "clock": 1636123719,
      "id": "c01168e3-e6e4-408c-803d-d99e1ab3ac8f"
    },
    {
      "clock": 1636123608,
      "id": "f20cd08e-12c8-4c6a-ba69-1d5cb4f648f7"
    },
    {
      "clock": 1636123530,
      "id": "7d438a88-6bf3-4d39-9334-ad545d68b8eb"
    },
    {
      "clock": 1636123428,
      "id": "31266099-c280-4698-ad39-0051ca37c099"
    },
    {
      "clock": 1636123420,
      "id": "8d437f32-be6c-4f93-8993-0f45e3a82251"
    },
    {
      "clock": 1636123413,
      "id": "1c35699e-9ce3-4874-98a4-359a1ad222b2"
    },
    {
      "clock": 1636123346,
      "id": "481d1db7-5a74-4410-b806-2b19d3debce8"
    }
  ],
  "paging": {
    "count": 71644,
    "page": 1,
    "items": 10,
    "pages": 7165
  }
}
Server

Cowboy

Date

Fri, 05 Nov 2021 14:51:15 GMT

Connection

keep-alive

X-Frame-Options

SAMEORIGIN

X-Xss-Protection

1; mode=block

X-Content-Type-Options

nosniff

X-Download-Options

noopen

X-Permitted-Cross-Domain-Policies

none

Referrer-Policy

strict-origin-when-cross-origin

Content-Type

application/json; charset=utf-8

Vary

Accept

Etag

W/"f28ed152e4f4eddbcd1307dd1bdbb266"

Cache-Control

max-age=0, private, must-revalidate

X-Request-Id

89777a3d-56fc-41c2-8412-eef0b4e95c23

X-Runtime

0.225701

Strict-Transport-Security

max-age=63072000; includeSubDomains

Transfer-Encoding

chunked

Via

1.1 vegur

GETGet my shots

https://visualizer.coffee/api/shots/?page=1&items=10

Get a (paginated) list of my personal shots.

Uses the userid/password from your account on visualizer.coffee.

AUTHORIZATIONBasic Auth
Username

[email from visualizer.coffee]

Password

[pwd from visualizer.coffee]

PARAMS
page

1

(optional) Requested page number (default = 1)

items

10

(optional) The size of your page (max = 100, default = 10).

Example Request
Get my shots
curl
curl --location 'https://visualizer.coffee/api/shots/?page=1&items=10'
200 OK
Example Response
json
{
  "data": [
    {
      "clock": 1636108686,
      "id": "904eee96-bbef-43cf-8bcc-e3a721dd555e"
    },
    {
      "clock": 1636094046,
      "id": "8357da14-6459-467f-adf3-6faa059b156f"
    },
    {
      "clock": 1636023818,
      "id": "b079731e-5de6-4aed-a5fe-4d41b9e40463"
    },
    {
      "clock": 1636011257,
      "id": "7ecd9c2e-7725-495d-a97f-a8d70d59f9b3"
    },
    {
      "clock": 1636010515,
      "id": "11b77777-48d4-421a-9405-818ea78547fb"
    },
    {
      "clock": 1635944542,
      "id": "afbefcfb-e694-4697-9fdc-1c6c16979c28"
    },
    {
      "clock": 1635923878,
      "id": "e1585fc3-0ddb-43aa-84e0-5a2768690472"
    },
    {
      "clock": 1635922810,
      "id": "68f38711-f26e-4073-9807-e20cf601d01e"
    },
    {
      "clock": 1635844997,
      "id": "39df6e88-6b01-434b-891b-4a4d8f574e43"
    },
    {
      "clock": 1635781298,
      "id": "e0296025-6639-4b60-b938-003d1b15e6e6"
    }
  ],
  "paging": {
    "count": 74,
    "page": 1,
    "items": 10,
    "pages": 8
  }
}
Server

Cowboy

Date

Fri, 05 Nov 2021 14:51:05 GMT

Connection

keep-alive

X-Frame-Options

SAMEORIGIN

X-Xss-Protection

1; mode=block

X-Content-Type-Options

nosniff

X-Download-Options

noopen

X-Permitted-Cross-Domain-Policies

none

Referrer-Policy

strict-origin-when-cross-origin

Content-Type

application/json; charset=utf-8

Vary

Accept

Etag

W/"889f87f5d91d18f82bbba90cb1e1c2db"

Cache-Control

max-age=0, private, must-revalidate

X-Request-Id

28ec7412-fc97-4258-b3b2-2c25321eb085

X-Runtime

0.259562

Strict-Transport-Security

max-age=63072000; includeSubDomains

Transfer-Encoding

chunked

Via

1.1 vegur

POSTUpload shot

https://visualizer.coffee/api/shots/upload

Upload a file in either TCL or JSON format of your shot.

Authentication is required

AUTHORIZATIONBasic Auth
Username

[email from visualizer.coffee]

Password

[pwd from visualizer.coffee]

Bodyfile
Example Request
Upload shot
curl
curl --location 'https://visualizer.coffee/api/shots/upload' \
--header 'Content-Type: text/plain' \
--data '@/Users/eriklenaerts/Downloads/test.tcl'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETGet shot data

https://visualizer.coffee/api/shots/[shotId]/download?essentials=true

Get Essential or complete info about the shot.

Be sure to provide a valid shotId in the path which can be acquired by listing all (your) shots.

Note: that some fields in the result payload may be empty (null), this means that the creator of the shot did not specify much details in the DYE page (Describe Your Espresso)

PARAMS
essentials

true

(optional) Omit this parameter if you need the complete shot data.

Example Request
Get shot - Essentials
curl
curl --location -g 'https://visualizer.coffee/api/shots/[shotId]/download?essentials=true'
200 OK
Example Response
json
{
  "profile_title": "Adaptive (for medium roasts)",
  "user_id": "a20da725-15e9-4dc2-9825-a8c3f79bb32d",
  "drink_tds": "0",
  "drink_ey": "0",
  "espresso_enjoyment": 0,
  "bean_weight": "18.2",
  "drink_weight": "0.0",
  "grinder_model": "Fiorenzato F4E Nano",
  "grinder_setting": "1.0",
  "bean_brand": "Normo",
  "bean_type": "Espresso blend",
  "roast_date": "04/10/2021",
  "espresso_notes": null,
  "roast_level": "medium roast",
  "bean_notes": "70% brazil, Sao Francisco de bela vista\n30% Ethiopia, HaloHartume",
  "start_time": "2021-11-05T06:34:06.000Z",
  "image_preview": "https://visualizer-coffee.s3.eu-central-1.amazonaws.com/screenshots/8357da14-6459-467f-adf3-6faa059b156f.png",
  "profile_url": "https://visualizer.coffee/api/shots/8357da14-6459-467f-adf3-6faa059b156f/profile"
}
Server

Cowboy

Date

Fri, 05 Nov 2021 09:15:55 GMT

Connection

keep-alive

X-Frame-Options

SAMEORIGIN

X-Xss-Protection

1; mode=block

X-Content-Type-Options

nosniff

X-Download-Options

noopen

X-Permitted-Cross-Domain-Policies

none

Referrer-Policy

strict-origin-when-cross-origin

Content-Type

application/json; charset=utf-8

Vary

Accept

Etag

W/"f2e3c7c1f5c99bc61fe1d608ef30f53b"

Cache-Control

max-age=0, private, must-revalidate

X-Request-Id

8cf43bd0-7f85-4210-8554-fd1a66ccbb48

X-Runtime

0.007634

Strict-Transport-Security

max-age=63072000; includeSubDomains

Transfer-Encoding

chunked

Via

1.1 vegur