Download tool to query API - why does it only work this way?

[craigja]

Im using the Download tool to query an in-house API - it all works, but I know very little about API's and was wondering... It takes in an expected_settlement_date field, the only way I can get this to work is to append the actual date I want passed in to the URL like below:

https://URL/vu_alteryx_discov_dealing_stats/30-Jun-2025

I thought I would be able to pass this in either the Headers or Payload sections but whenever I try it always fails, just wondered why this was or am I doing something slightly wrong?

[craigja]

So, just discovered if I add that field in the Headers section as a constant value, so the top section of the Headers Tab, it works, I initially tried just checking the field name in the bottom box on this tab but that doesnt work.  How can I pass in different dates if the only way is to make it a constant?  So the top bit works, but if I delete this and check the field name at the bottom it fails

[craigja]

Ignore that last reply!  It only worked as I had left the date in the URL!

[Gaurav_Dhama_]

Have you tried passing it as parameter instead? For example:

[craigja]

yeah and that doesnt work

[abacon · Accepted solution]

@craigja it all depends on the API you are using - my usual method for getting APIs to work in Alteryx is to first use Postman to build it out and understand the queries I need to make.

Does your in-house API have any documentation that guides you on how to query it correctly? I know with some you put it straight in the 'parameters' section, not the headers or the body which would be the URL you are talking about.

If I were you, I would reach out to who developed the in-house API to better understand how it works or for documentation that will give you the information.

Bacon

[craigja]

Ah, ok it probably is just the parameters like you said then - the other developer Im working with on this is an Oracle developer who is using the API already and he just uses the full URL  as well.