Get interactions

get https://reportingapi.digitalcx.com/{customerKey}/projects/{projectKey}/interactions

Get all interactions in a specified timeframe (start-end). Only includes interactions on the 'live' environment (api.digitalcx.com)

Path Params

customerKey

string

required

Customer identifier used for authenticating the request.

projectKey

string

required

Project identifier used for authenticating the request, and to determine what project environment the interaction will take place in.

Query Params

culture

string

required

Points to the culture of the project, which determines what content within the projects scope the answer will originate from.

begin

string

required

Start date for the query (DD-MM-YYYY).

end

string

required

End date (inclusive) for the query (DD-MM-YYYY).

filterText

string

Text filter on interaction values

paginateData

boolean

Determines if a paginated response should be returned.

continuationToken

string

Token that indicates where pagination should continue from.

includeUserInfo

boolean

Determines if user information should be returned.

interactionTypes

Interaction type filter:

Event: 1
QA: 2
QA and Event: 3
FAQClick: 4
Dialog: 8
LinkClick: 16
Feedback: 32
FAQSearch: 64
All: All

Response

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://reportingapi.digitalcx.com/customerKey/projects/projectKey/interactions \
3
     --header 'accept: text/csv'

Click Try It! to start a request and see the response here! Or choose an example:

text/csv

200OK