.NET API

To use the Alteryx API, include AlteryxAPI.Net.dll as a reference in your project. Then, copy the required DLLs to the appropriate folders. The required DLLs are found in the C:\Program Files\Alteryx\bin\ folder in your Alteryx Designer installation.

Prerequisites
You must have Visual C++ 2015 installed globally to use the .NET API. Alternatively, you can include the Visual C++ 2015 redistributable DLLs. You can find the DLLs in the Alteryx Designer installation folder: C:\Program Files\Alteryx\bin\.
For more information about the Alteryx API, visit the API documentation in the Alteryx Designer installation folder: C:\Program Files\Alteryx\APIs\AlteryxEngineAPI.chm.

Copy required DLLs

The .NET DLLs contain resources required by the Alteryx API and must be copied to the appropriate folders for your executable to function properly.

  1. Create a folder structure to store the required DLLs.
  2. Include the following DLL as a reference in your project:

    C:\Program Files\Alteryx\bin\AlteryxAPI.Net.dll

    C:\Program Files\Alteryx\bin\AlteryxDocument.dll

    C:\Program Files\Alteryx\bin\Base.Net.dll

  3. Copy the following DLLs to the same folder where you plan to load AlteryxAPI.Net.dll:
    • C:\Program Files\Alteryx\bin\FlxComm64.dll
    • C:\Program Files\Alteryx\bin\FlxConnect64.dll
    • C:\Program Files\Alteryx\bin\FlxCore64.dll
  4. Copy the following DLL to the same folder as the executable that will call into AlteryxAPI.Net.dll:

    C:\Program Files\Alteryx\bin\Base.dll

Example folder structure

  • YourApp.exe
  • Base.dll
  • Libs
    • AlteryxAPI.Net.dll
    • AlteryxDocument.dll
    • Base.Net.dll
    • FlxComm64.dll
    • FlxConnect64.dll
    • FlxCore64.dll