# Get interactions

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

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Reporting",
    "version": "4.0.10"
  },
  "servers": [
    {
      "url": "https://reportingapi.digitalcx.com/",
      "description": "Reporting API"
    }
  ],
  "tags": [
    {
      "name": "Reporting",
      "description": "Conversational AI Cloud's Reporting API provides the ability to retrieve interaction logs generated for each Gateway interaction."
    }
  ],
  "paths": {
    "/{customerKey}/projects/{projectKey}/interactions": {
      "get": {
        "tags": [
          "Reporting"
        ],
        "summary": "Get interactions",
        "description": "Get all interactions in a specified timeframe (start-end). Only includes interactions on the 'live' environment (api.digitalcx.com)",
        "security": [
          {
            "accessToken": [],
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/cultureParam"
          },
          {
            "name": "customerKey",
            "in": "path",
            "description": "Customer identifier used for authenticating the request.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "projectKey",
            "in": "path",
            "description": "Project identifier used for authenticating the request, and to determine what project environment the interaction will take place in.",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "begin",
            "in": "query",
            "description": "Start date for the query (DD-MM-YYYY).",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "end",
            "in": "query",
            "description": "End date (inclusive) for the query (DD-MM-YYYY).",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "filterText",
            "in": "query",
            "description": "Text filter on interaction values",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "paginateData",
            "in": "query",
            "description": "Determines if a paginated response should be returned.",
            "schema": {
              "type": "boolean"
            },
            "required": false
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "Token that indicates where pagination should continue from.",
            "schema": {
              "type": "string"
            },
            "required": false
          },
          {
            "name": "includeUserInfo",
            "in": "query",
            "description": "Determines if user information should be returned.",
            "schema": {
              "type": "boolean"
            },
            "required": false
          },
          {
            "name": "interactionTypes",
            "in": "query",
            "description": "Interaction type filter:\n * Event: 1\n * QA: 2\n * QA and Event: 3\n * FAQClick: 4\n * Dialog: 8\n * LinkClick: 16\n * Feedback: 32\n * FAQSearch: 64\n * All: All\n",
            "schema": {
              "enum": [
                1,
                2,
                4,
                8,
                16,
                32,
                64,
                "All"
              ]
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/csv": {
                "schema": {
                  "type": "string",
                  "example": "logid|interactionuuid|sessionuuid|timestamputc|projectid|culture|useridentifier|useruuid|previouspage|originatingpage|interactiontype|interactionvalue|eventkbaname|dialogname|dialognodetype|activatedcontext|kbaid|outputtext|outputmetadata|recognitionrate|messagecontent|linksavailable|linkclickoriginatinginteractionid|linkclickurl|feedbackoptionshown|feedbacklabel|feedbackscore|feedbackcomment|feedbackoriginatinginteractionid|resultlist|modeid"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "cultureParam": {
        "name": "culture",
        "in": "query",
        "description": "Points to the culture of the project, which determines what content within the projects scope the answer will originate from.",
        "schema": {
          "type": "string"
        },
        "required": true
      }
    },
    "securitySchemes": {
      "accessToken": {
        "description": "JWT used to access the Reporting API",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "apiKey": {
        "description": "Conversational AI Cloud API key",
        "type": "apiKey",
        "in": "query",
        "name": "apikey"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 38,
      "2": 80,
      "3": 241,
      "4": 119,
      "5": 168,
      "6": 50,
      "7": 0,
      "8": 62,
      "9": 32,
      "10": 220,
      "11": 119
    }
  }
}
```