Skip to main content

Star Rating - Upload Logo

Endpoint

/i/feedback/upload

Overview

Uploads a star-rating image asset into plugin storage.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires global_plugins Update permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
feedback_logoFileConditionalPreferred upload field for feedback logo file.
fileFileConditionalGeneric fallback upload field (used with name).
nameStringConditionalRequired with file; used as output file identifier.

Examples

/i/feedback/upload?
api_key=YOUR_API_KEY

Multipart form body:

feedback_logo=@/path/to/logo.png

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when file upload completes.

Error Responses

  • 400
{
"result": "Invalid image format. Must be png or jpeg"
}
  • 400
{
"result": "Invalid file extension. Must be .png, .jpg, .gif or .jpeg"
}
  • 400
{
"result": "Failed to upload image"
}

Standard authentication/authorization errors from update validation can also be returned.

Behavior

  • Endpoint is disabled when Surveys plugin is enabled (surveysEnabled branch returns false).
  • Accepts either feedback_logo or fallback file + name combination.
  • Validates MIME (image/png, image/gif, image/jpeg) and extension (gif|jpeg|jpg|png).
  • Stores image through Countly FS with overwrite mode.

Limitations

  • Only image formats/extensions listed above are accepted.
  • Endpoint is unavailable when Surveys plugin is active.
Implementation details

Database Collections

This endpoint does not read or write MongoDB collections directly.