Skip to main content

Surveys - Upload Logo

Endpoint

/i/feedback/upload

Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Uploads survey branding images and stores them in GridFS.

Authentication

Authentication methods:

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

  • Global Plugins: Update permission.

Request Parameters

Multipart form-data:

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication
feedback_logoFileConditionalPrimary feedback logo key
fileFileConditionalGeneric upload key when name is provided
nameStringConditionalTarget file key for generic upload

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringUpload status

Error Responses

  • HTTP 400 - File too large or invalid:
{
"result": "feedback.image-error"
}
  • HTTP 400 - File read/processing issue:
{
"result": "feedback.imagee-error"
}

Behavior/Processing

  • Requires global_plugins update permission.
  • Accepts feedback_logo to overwrite the global feedback logo.
  • Alternatively accepts generic file plus required name to write a named file into the feedback GridFS bucket.
  • Returns Missing file: feedback_logo or file when no usable upload field is present.
  • Returns Missing parameter: name when file is used without name.
  • Maximum file size is 1.5 MB.
  • Converts the file to a base64 data URI and writes it to GridFS bucket feedback with writeMode=overwrite.

Database Collections

CollectionUsed forData touched by this endpoint
countly_fs.feedback.filesEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.
countly_fs.feedback.chunksEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.

Examples

curl -X POST "https://your-server.com/i/feedback/upload?api_key=YOUR_API_KEY" \
-F "feedback_logo=@./survey-logo.png"

Limitations

  • Only image file inputs are supported.
  • One file is processed per request.

Ⓔ Enterprise

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions.


Last Updated

2026-04-18