Q: Who is responsible for managing currency conversion?
R: Currency conversion is the advertiser’s responsibility to manage on their side. Webgains provides an API endpoint to retrieve the most recent exchange rates available: https://docs.webgains.dev/docs/platform-api-1/d839c2c1a216e-get-exchange-rates , or there are other exchange rate providers online that can be used.
Q: What is the default timezone used by the API?
A: UTC is the default timezone format used by the API, although Webgains supports all standard timezone options. You can view the supported timezone list here: https://www.php.net/manual/en/timezones.php.
Q: Some endpoints requires a “currency” parameter. Is there an endpoint or documented list of currencies that are applicable?
A: The currency will be returned based on the network.
Q: For the “locale” parameter, is there a documented list of locales that can be used?
A: The ID for each network locale is below.
Q: Does the API support all timezone requests? Is there an applicable list of timezones?
A: The list of supported timezones should follow the PHP supported timezones list: https://www.php.net/manual/en/timezones.php
Q: Is there a way to paginate results for the endpoint?
A: The Publisher Performance Report endpoint does not have pagination, as it returns the top publishers, which can be defined using the “limit” parameter.
For support with pagination on other endpoints, please view: https://docs.webgains.dev/docs/platform-api-1/p10q068ws5146-pagination
Q: Is there a maximum value for the limit parameter?
A: There is no maximum value for the limit parameter.
Q: Is there a default locale associated with the authorising user, and can this be retrieved from an endpoint?
A: The locale depends on the program and its home network country. There is no specific endpoint that returns a default locale. However, you may be able to use the Get User Details endpoint, which returns the Network ID: https://docs.webgains.dev/docs/platform-api-1/azmi78unhnisi-get-user-details.
Note that a merchant may have multiple program across different networks/markets. For example, the merchant’s home network may be the UK, while they also have additional programs in France, Germany, or other countries. The user is attached to the Merchant account (in this example, UK).