Advanced Reports API Explained

Advanced Reports API

Info
We have created a public API collection for Advanced Reports module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post.

1. Amasty\Reports\Api\RuleRepositoryInterface - class for managing rules for reports configuration:
  1. POST /V1/amasty_reports/rule, method="save" - create a rule;
  2. PUT /V1/amasty_reports/rule/:entityId, method="save" - edit a rule;
  3. DELETE /V1/amasty_reports/rule/:entityId, method="deleteById" - delete a rule;
  4. GET /V1/amasty_reports/rule, method="getById" - get information about a rule;
  5. GET /V1/amasty_reports/rule/all, method="getList" - get a list with all rules.

      • Related Articles

      • What Amasty extensions support API?

        Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...

      • Can I test how your modules work with API?

        Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be ...

      • Advanced Search API

        We have created a public API collection for Advanced Search module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public ...

      • ChatGPT AI Content Generator API

        We have created a public API collection for ChatGPT AI Content Generator module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using ...

      • Advanced Product Reviews | GraphQL methods

        Queries advreview description: get product reviews amReviewSetting description: get Advanced Product Reviews module settings amReviewWidget description: get information about Reviews widget Mutations addAdvReview description: add review addAdvComment ...