API docs by Redocly

Activity Feedback API (1.0.0)

Download OpenAPI specification:Download

API for managing activity feedback

Activity Feedback

Activity feedback management operations

Get all activity feedback

Retrieve a list of all activity feedback with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

client
string

Filter by client ID

rating
integer [ 1 .. 5 ]

Filter by rating

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create new activity feedback

Create a new activity feedback entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
activity_type
required
string

Type of activity this feedback is for

activity_id
string

ID of the related activity

rep
required
string

Representative ID

client
string

Client ID

rating
required
integer [ 1 .. 5 ]

Feedback rating (1-5 scale)

feedback_text
string

Detailed feedback text

feedback_categories
Array of strings

Categories of feedback

is_anonymous
boolean
Default: false

Whether the feedback is anonymous

source
string
Default: "mobile_app"
Enum: "mobile_app" "web_portal" "email" "sms" "phone"

Source of the feedback

response_time
integer

Time taken to provide feedback (in seconds)

Array of objects
follow_up_required
boolean
Default: false

Whether follow-up is required

follow_up_notes
string

Notes for follow-up actions

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "activity_type": "sales_visit",
  • "activity_id": "507f1f77bcf86cd799439012",
  • "rep": "507f1f77bcf86cd799439013",
  • "client": "507f1f77bcf86cd799439014",
  • "rating": 4,
  • "feedback_text": "Great service, very professional",
  • "feedback_categories": [
    ],
  • "is_anonymous": false,
  • "source": "mobile_app",
  • "response_time": 0,
  • "attachments": [
    ],
  • "follow_up_required": false,
  • "follow_up_notes": "string",
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get activity feedback by ID

Retrieve a specific activity feedback by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update activity feedback

Update an existing activity feedback

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Request Body schema: application/json
rating
integer [ 1 .. 5 ]

Feedback rating (1-5 scale)

feedback_text
string

Detailed feedback text

feedback_categories
Array of strings

Categories of feedback

follow_up_required
boolean

Whether follow-up is required

follow_up_notes
string

Notes for follow-up actions

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "rating": 1,
  • "feedback_text": "string",
  • "feedback_categories": [
    ],
  • "follow_up_required": true,
  • "follow_up_notes": "string",
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete activity feedback

Delete an activity feedback by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get feedback analytics

Get analytics and statistics for activity feedback

Authorizations:
ApiKeyAuth
query Parameters
date_from
string <date>

Start date for analytics

date_to
string <date>

End date for analytics

activity_type
string

Filter by activity type

rep
string

Filter by representative ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}