January 27, 2018

Support for Date Filters in API Method for Applying Filters to Dashboard

We have enhanced the API method 'Apply filters to a dashboard'. This method lets you apply filters to an embedded dashboard or a dashboard with embedded content.
In addition to attribute filters, you can now use this method to apply date filters.

If you are using the event to track changes of filters on an embedded dashboard or a dashboard with embedded content, this event now reports on changing date filters in addition to attribute filters.

Learn more:
Embedded Dashboard and Report API - Events and Methods
(look for 'Apply attribute and date filters to a dashboard' and 'Dashboard attribute and date filters changed')


API Updates

The following API update have been implemented:

There is a backward incompatible change on /gdc/md/<project-id>/userfilters API which serves data permission assigning to users.
This command can only be used by the owner of domain that the <login> belongs to. If you receive "Unknown user or user URI is wrong." when you use <login>, use <user-id> instead.


Changes in Free Trial

We are planning to change how the free trial works on the GoodData platform.

As of now, you create a free GoodData account from the GoodData platform landing page and sign up for the free trial. Going forward, this option will no longer be available.
However, both new and existing customers will be able to try the GoodData platform free of charge.

We will post a detailed announcement when this change is made.


REMINDER: Add Mandatory User-Agent Header to API Request

Starting from March 31, 2018, the GoodData REST API will require every API request to contain the User-Agent header. Any API request without the User-Agent header made after March 31, 2018, will be rejected.

What is the purpose of the header?
The User-Agent header helps us identify users of our API and what they use the API for.

What is the header format?
The User-Agent header must be in one of the following formats:

  • {product}-{task}/{version} ({your_email@example.com})
  • {company}-{task}/{version}

-- {product} is the product in whose context you use the API (it can be your company's product that you are responsible for).
-- {task} is the business domain in which you use the API (for example, managing users, configuring white-label properties, or creating projects).
-- {company} is your company name.
-- {version} is the version of your API integration. If you are not sure what version to include, set it to 1.0.
-- {your_email@example.com} is your email or the email of the contact person responsible for the product in your company.

The User-Agent header must not contain spaces or slashes ( / ) apart from those that are already specified by the format.

How can you construct the User-Agent header?
Use the following examples to understand how to set the header:

  • John Roe works in a company called 'Acme Corporation', on a product called 'Insight'. He uses the GoodData API to orchestrate ETL graphs across projects in his department. Here is how John can set the User-Agent header:
    Insight/1.0 (john.roe@acme.com)
  • Jane Doe works in a company called 'Initech'. She uses the GoodData API to perform general administrative tasks across multiple products. Here is how Jane can set the User-Agent header:

Action needed!
If you use a tool for handling API calls or a custom library for integrating with the GoodData REST API, update them to include the User-Agent header in every API request.
TIP: Set up one User-Agent header per tool/custom library and per task. For example, if you are using one tool to perform many administrative tasks, use a general header of AdminTools. However, if you are using a few tools or libraries or if you are performing tasks from different business areas (for instance, managing access to dashboards and adding users to a Data Warehouse instance), set up headers for each tool or for each task separately.

When is the deadline for implementing the User-Agent header? 
The date is March 31, 2018. However, we strongly recommend that you do so as soon as possible.

Are CloudConnect users affected?
No. If you call the API from CloudConnect (for example, REST Connector or HTTP Connector), you do not have to specify the User-Agent header. CloudConnect provides a default User-Agent header for all API calls that these components make.

If you have any question, please contact GoodData Support.

Powered by Zendesk