Resource functions
- add_alternative_file
- copy_resource
- create_resource
- delete_alternative_file
- delete_comment
- delete_resource
- get_alternative_files
- get_edit_access
- get_related_resources
- get_resource_access
- get_resource_all_image_sizes
- get_resource_comments
- get_resource_data
- get_resource_field_data
- get_resource_log
- get_resource_path
- get_resource_types
- put_resource_data
- relate_all_resources
- replace_resource_file
- resource_file_readonly
- resource_log_last_rows
- upload_file
- upload_file_by_url
- upload_multipart
- update_related_resource
- update_resource_type
Collection functions
Search functions
IIIF
Metadata functions
User functions
System
Message functions
Plugin functions
- consentmanager_get_consents
- licensemanager_get_licenses
- consentmanager_get_consent
- consentmanager_delete_consent
- consentmanager_batch_link_unlink
- consentmanager_link_consent
- consentmanager_unlink_consent
- consentmanager_create_consent
- consentmanager_update_consent
- consentmanager_get_all_consents
- consentmanager_get_all_consents_by_collection
- consentmanager_save_file
do_report
Run a report and return the data using the API.
* Available from version 11.0.
| Variable | Description | Data type |
|---|---|---|
| $report_ref * | ID of the report to run. | integer |
|
$from_date
|
Start date of reporting period in format YYYY-MM-DD. If not supplied, default will be 7 days ago. | string |
| $to_date | Start date of reporting period in format YYYY-MM-DD. If not supplied, default will be today. | string |
Return values
Returns false if permissions are insufficient to run reports or the date format supplied is incorrect.
Returns array of report data on success, the content depending on the report chosen.
Note: not all reports use the date range provided here. Check the report SQL for confirmation.
Where the report chosen includes a thumbnail column, the returned array will contain two keys:
"thumbnail" - containing a base64 encoded thumbnail image in jpg format.
"thumbnail_view_resource" - containing a link to the view page for the resource (accessible to logged in users).