Skip to main content

Symon.AI help center

REST API connector

Connect Symon.AI to your REST API import connector to import your data.

Importing data
  1. In Symon.AI, go to the Data tab.

  2. Click Import data.

  3. In the Third party sources section, click REST API.

  4. Click New connection.

  5. On the Connect to your API page, enter the following information to connect:

    Table 15. REST API

    Field

    Description

    Connector name

    The name of the connection.

    Authentication method

    The method to use to authenticate. Choose from None, Basic, or API key.

    • None: There is no authentication method.

    • Basic: Enter your Username and Password.

    • API key: Enter the Authentication header.

    Table name

    The name of the table to get the data from, such as tickets.

    Endpoint URL

    The URL for the REST API, such as https://yourwebsite/com/api/v2/tickets.

    Path to data

    The path to access the data. You can also select to Flatten the data.

    Table key

    The name of the table key to get the data from, such as id.

    Pagination

    The type of pagination, such as none, paged, offset or cursor.

    • None: There is no other information to enter.

    • Paged: Enter the First page number, the Last page error code and the Request page label.

    • Cursor: Enter the Last page error code, Request page size, Request page size label and Cursor label.

    • Offset label: Enter the Path to offset, Last page error code, Request page size, Request page size label and Offset label.



  6. Click Next.

  7. On the Choose data sets page, select one or more data sets to include. Click Next.

  8. On the Import data page, configure the column type and obfuscation. Click Next.

  9. On the Review page, review the data sets that you are importing.

    The data is available on the My Data page.