API docs by Redocly

Activity Feedback V2 API (2.0.0)

Download OpenAPI specification:Download

API for managing activity feedback (version 2)

Activity Feedback V2

Activity feedback v2 management operations

Get all activity feedback v2

Retrieve a list of all activity feedback v2 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

overall_satisfaction
integer [ 1 .. 10 ]

Filter by overall satisfaction rating

template_id
string

Filter by feedback template ID

_id
Array of strings

Filter by ID

Responses

Response samples

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

Create new activity feedback v2

Create a new activity feedback v2 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

template_id
required
string

Feedback template ID used

overall_satisfaction
required
integer [ 1 .. 10 ]

Overall satisfaction rating (1-10 scale)

Array of objects
nps_score
integer [ 0 .. 10 ]

Net Promoter Score (0-10)

completion_time
integer

Time taken to complete feedback (in seconds)

object
is_anonymous
boolean
Default: false

Whether the feedback is anonymous

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",
  • "template_id": "507f1f77bcf86cd799439015",
  • "overall_satisfaction": 8,
  • "responses": [
    ],
  • "nps_score": 10,
  • "completion_time": 0,
  • "session_data": {
    },
  • "is_anonymous": false,
  • "company_namespace": [
    ]
}

Response samples

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

Get activity feedback v2 by ID

Retrieve a specific activity feedback v2 by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Responses

Response samples

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

Update activity feedback v2

Update an existing activity feedback v2

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Request Body schema: application/json
overall_satisfaction
integer [ 1 .. 10 ]

Overall satisfaction rating (1-10 scale)

Array of objects
nps_score
integer [ 0 .. 10 ]

Net Promoter Score (0-10)

Array of objects
company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "overall_satisfaction": 1,
  • "responses": [
    ],
  • "nps_score": 10,
  • "follow_up_actions": [
    ],
  • "company_namespace": [
    ]
}

Response samples

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

Delete activity feedback v2

Delete an activity feedback v2 by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity feedback v2 ID

Responses

Response samples

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

Get detailed feedback analytics

Get detailed analytics and insights for activity feedback v2

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

template_id
string

Filter by feedback template ID

Responses

Response samples

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