Using this interactive documentation

Subscription users can use the "Try it out!" feature of the API documentation by providing the API key and secret found in the Keys section of account settings on the Alteryx Gallery.

All Alteryx question types are supported except for the following:

  • Trees
  • File Browse
  • Maps

To create your own client, you need to use 3rd-party signature generation code that uses the OAuth 1.0a standard.

The Gallery API doesn’t implement the full, 3-legged OAuth 1.0a flow. We only require the signature generation. This is sometimes called a 1-legged flow. See the Signing Process section of the OAuth 1.0a specification for information.

These OAuth parameters are required for every API call:

  • oauth_consumer_key
  • oauth_signature_method (must be HMAC-SHA1)
  • oauth_signature
  • oauth_timestamp
  • oauth_nonce

Oauth Parameter Notes:

  • For enhanced security, we recommend that you send OAuth parameters as headers. 
  • The oauth_version paramater is optional, but if present, has to be 1.0
  • Any additional parameters starting with oauth_ will be ignored.

Constructing API Endpoints:

To construct an API endpoint use this schema: {serverBaseAddress}/api/{endpoint}. For example, if the base address in system settings is https://my.server.tld/gallery you have to prepend each endpoint in the API documentation with https://my.server.tld/gallery/api.

You can reference a fully-functional sample Alteryx client in C# or JavaScript.

Using this interactive documentation

Admins can use the "Try it out!" feature of the API documentation by providing the API key and secret found on the Keys section of account settings of a private Gallery.

All Alteryx question types are supported except for the following:

  • Trees
  • File Browse
  • Maps

To create your own client, you need to use 3rd-party signature generation code that uses the OAuth 1.0a standard.

The Gallery API doesn’t implement the full, 3-legged OAuth 1.0a flow. We only require the signature generation. This is sometimes called a 1-legged flow. See the Signing Process section of the OAuth 1.0a specification for information.

These OAuth parameters are required for every API call:

  • oauth_consumer_key
  • oauth_signature_method (must be HMAC-SHA1)
  • oauth_signature
  • oauth_timestamp
  • oauth_nonce

Oauth Parameter Notes:

  • For enhanced security, we recommend that you send OAuth parameters as headers. 
  • The oauth_version paramater is optional, but if present, has to be 1.0
  • Any additional parameters starting with oauth_ will be ignored.

Constructing API Endpoints:

To construct an API endpoint use this schema: {serverBaseAddress}/api/{endpoint}. For example, if the base address in system settings is https://my.server.tld/gallery you have to prepend each endpoint in the API documentation with https://my.server.tld/gallery/api.

You can reference a fully-functional sample Alteryx client in C# or JavaScript.

Using this interactive documentation

Admins can use the "Try it out!" feature of the API documentation by providing the API key and secret found on the Keys section of account settings of a private Gallery.

All Alteryx question types are supported except for the following:

  • Trees
  • File Browse
  • Maps

To create your own client, you need to use 3rd-party signature generation code that uses the OAuth 1.0a standard.

The Gallery API doesn’t implement the full, 3-legged OAuth 1.0a flow. We only require the signature generation. This is sometimes called a 1-legged flow. See the Signing Process section of the OAuth 1.0a specification for information.

These OAuth parameters are required for every API call:

  • oauth_consumer_key
  • oauth_signature_method (must be HMAC-SHA1)
  • oauth_signature
  • oauth_timestamp
  • oauth_nonce

Oauth Parameter Notes:

  • For enhanced security, we recommend that you send OAuth parameters as headers. 
  • The oauth_version paramater is optional, but if present, has to be 1.0
  • Any additional parameters starting with oauth_ will be ignored.

Constructing API Endpoints:

To construct an API endpoint use this schema: {serverBaseAddress}/api/{endpoint}. For example, if the base address in system settings is https://my.server.tld/gallery you have to prepend each endpoint in the API documentation with https://my.server.tld/gallery/api.

You can reference a fully-functional sample Alteryx client in C# or JavaScript.