Pixel Perfect Reports - API generation issue

Q&A
, , , , ,
1

Hi team,

I recently started using PIxel Perfect reports (as an Enterprise User) and have created something simple as my first report and plan on generating a report using the API via SageMaker for testing (then creating a Lambda once the code it working). The report has a couple of tables and parameters linked to them and is only two pages - so, quite a simple report.

I have read this blog post and I’m trying to mimic the functionality - Automate financial statements using Amazon Quick Sight Snapshot Export APIs - Learn / Blogs - Amazon Quick Suite Community

I’m having some issues with generating the “start_dashboard_snapshot_job” call - as I keep being returned “FAILED”.

When I run “describe_dashboard_snapshot_job_result” - I’m retruned:

‘JobStatus’: ‘FAILED’,
‘Result’: {‘AnonymousUsers’: },
‘ErrorInfo’: {‘ErrorMessage’: ‘Encountered an internal error’,
‘ErrorType’: ‘INTERNAL_ERROR’},

Unfortunately - there is no other information here as to what could be going wrong, so debugging this is quite difficult.

I have read that INTERNAL_ERROR could be due to the dashboard not loading correctly because a parameter may have been passed incorrectly OR it could simply be a QuickSuite issue.

The reports has the below Parameters - I’m passing all of these in the request:

StringParameters -

salesMarket

salesRegion

Datetime -

reportDate - this is a date used to represent the reporting week (i.e. prev Monday)

startDate - start date of the reporting period

endDate - end date of the reporting period

Does anyone have any ideas on what could be causing this or have experience in debugging this issue? I’m at a loss as to where to go next.

Any help would be greatly appreciated.

Regards,
Q

2

I have worked out my issue through a series of trial and error.

It seems when I did not pass the “DestinationConfiguration” argument, the report would run. It would then return a S3Uri to me, which is where I had to pick up the report.

Seems it doesnt like the bucket and where you are writing the data to, to be in different regions. Once I changed this, i was able to write the file to the correct destination with the “DestinationConfiguration”.

QuickSuite API team -

Are you able to have some validations put in place for this prior to the API call being made? I know there is some validation being done prior to sending the payload, but it would be helpful to know this prior to sending the request.

Alternatively, can we get better error responses back from the API instead of simply returning INTERNAL_ERROR?

3

Hi @QSCommUser,

I’m glad you were able to work through your issue!
In regards to the error responses, this is a fairly common request as the errors often don’t help point in the right direction. While I can not say if this is a potential feature that will be implemented down the road, I’ll mark this as a feature request to promote visibility to the support team regarding clearer error message prompts.