Docs API Reference Post Feedback/api/v1/post-feedback/

/api/v1/post-feedback/

Stores a 1-5 rating and an optional note for a post identified by its public external id. Used by the public /post-feedback page on bizkithub.com.

post-feedbackpostApiV1Post-feedback

Parameters

1 query · JSON body

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

postIdstringRequired

Post public id (content__post.external_id), 16 chars.

Length: 16–16

Example6IU2SWgP76FO2UXw

scorestring | integerRequired

1 = velmi špatné, 5 = výborné.

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

1 = velmi špatné, 5 = výborné.

Range: 1–5

Example5

descriptionstringOptional

Optional free-form note from the visitor.

Length: 0–1000

ExampleSkvělý článek, jen by chtělo víc příkladů.

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

success"true"Required

Variant 2

state"error"Required

messagestringRequired

code"200"Required

hintstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

Response example

application/json

{
  "success": true
}

Request example

POST /api/v1/post-feedback/

post

curl -X POST "https://api.bizkithub.com/api/v1/post-feedback/?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "postId": "6IU2SWgP76FO2UXw",
  "score": 5,
  "description": "Skvělý článek, jen by chtělo víc příkladů."
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key