Skip to content

API reference: feedback

Messages to Mission Control, the Astro Notes crew, within a yearly allowance set by the plan. And ideas for the public feedback board, shared and backed as the account’s own board user, with their statuses, which the board’s webhook keeps current.

POST /v1/feedback

Stores a feedback message and relays it to Mission Control. Needs a session.

A verified account email receives a copy and becomes the Reply-To address. A message with a report reports a bridge transmission: it never counts against the allowance, and an account sends a few a day.

Request body, application/json: FeedbackRequest

Responses
Status Description Body
200

Message sent, updated allowance.

FeedbackQuota application/json
400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
402

Free plan allowance used

Problem application/problem+json
403

A report by an account holding no key of the bridge’s

Problem application/problem+json
404

A report of a transmission the reporter couldn’t read, or that the bridge no longer holds

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

Yearly allowance used, or the day’s reports

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

GET /v1/feedback-quota

Returns the caller's feedback allowance and rolling-year usage. Needs a session.

Responses
Status Description Body
200

Feedback allowance and usage.

FeedbackQuota application/json
401

No valid session token

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

GET /v1/ideas

The account's ideas, and how a new one would be shared. Needs a session.

Parameters
Name In Type Description
refresh query boolean

Reads the account’s ideas from the board again before answering.

Responses
Status Description Body
200

The account’s ideas.

IdeasView application/json
400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

POST /v1/ideas

Shares a new idea on the public board as the account, which backs and follows it. Needs a session.

The idea is public on the board, under the account’s handle. Its address goes to the board only with the account’s first idea, and only when emailUpdates asks.

Request body, application/json: IdeaRequest

Responses
Status Description Body
201

Shared.

Idea application/json
400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
403

The board withdrew the account

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

The week’s ideas are shared

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

Ideas not offered, or the board isn’t answering

Problem application/problem+json

GET /v1/ideas/blocked

The people the account blocked, newest first. Needs a session.

Responses
Status Description Body
200

Who the account blocked.

BlockedPeople application/json
401

No valid session token

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

POST /v1/ideas/blocked

Blocks the author of an idea for the account, and tells the crew. Needs a session.

The author is read from the board. Their ideas leave every read of the account’s ideas, on all its devices, and they aren’t told. A new block tells the crew of the idea once, while the day’s reports allow; past them, it holds untold. Blocking the same person again answers the block as it stands.

Request body, application/json: TheirIdea

Responses
Status Description Body
200

Blocked.

BlockedPerson application/json
400

The account’s own idea

Problem application/problem+json
401

No valid session token

Problem application/problem+json
404

No such idea

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

Ideas not offered, or the board isn’t answering

Problem application/problem+json

DELETE /v1/ideas/blocked/{id}

Unblocks someone, whose ideas show again. Needs a session.

Parameters
Name In Type Description
id (required) path integer (int64)

Their user on the board.

Responses
Status Description Body
204

Unblocked, or never blocked.

400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

POST /v1/ideas/reports

Reports an idea to the crew, without blocking its author. Needs a session.

The crew is told of the idea and its author, read from the board, once an account: a second report of it answers as the first did. Reports of ideas and of bridge transmissions share the day’s.

Request body, application/json: TheirIdea

Responses
Status Description Body
204

Reported.

400

The account’s own idea

Problem application/problem+json
401

No valid session token

Problem application/problem+json
404

No such idea

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

The day’s reports

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

Ideas not offered, or the board isn’t answering

Problem application/problem+json

GET /v1/ideas/similar

Ideas on the board whose words match a title being typed, so it can be backed instead. Needs a session.

Parameters
Name In Type Description
query (required) query string

The title as typed so far.

Responses
Status Description Body
200

Up to 5 ideas.

SimilarIdeas application/json
400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

Ideas not offered

Problem application/problem+json

POST /v1/ideas/status

Receives the board's status changes: the token it sends as a bearer is the credential, since the board signs nothing it sends, and a header, never the address, so no access log keeps it. An idea that shipped is told of again, even one told of before. Needs no session.

Set in the board’s webhooks for Change Status, as JSON with the content type application/json, the header Authorization: Bearer and the webhook’s token, and the body {"post_number": {{ .post_number }}, "post_status": "{{ .post_status }}"}.

Parameters
Name In Type Description
Authorization (required) header string

Bearer and the token the webhook was configured with.

Request body, application/json: object

Responses
Status Description Body
204

Recorded.

400

Not a status change

Problem application/problem+json
404

No webhook at this address

Problem application/problem+json
413

The body is too large

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json

POST /v1/ideas/{number}/votes

Backs an idea already on the board as the account, which then follows it. Needs a session.

Parameters
Name In Type Description
number (required) path integer (int64)

The idea’s number on the board.

Request body, application/json: BackRequest

Responses
Status Description Body
200

Backed.

Idea application/json
400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
403

The board withdrew the account

Problem application/problem+json
404

No such idea

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

Ideas not offered, or the board isn’t answering

Problem application/problem+json

POST /v1/ideas:acknowledge

Marks shipped ideas as told, so the app tells of each once. Needs a session.

Request body, application/json: Told

Responses
Status Description Body
204

Marked.

400

The request is malformed

Problem application/problem+json
401

No valid session token

Problem application/problem+json
413

The body is too large

Problem application/problem+json
415

The body is not JSON

Problem application/problem+json
429

Too many requests

Problem application/problem+json
500

The service failed

Problem application/problem+json
503

The service is at capacity

Problem application/problem+json