Add products and product stats analytics reports to API doc #249
Conversation
|
@woocommerce/proton I couldn't find team proton/automata in the reviewer section, probably needs someone to add it in the repo settings. |
barryhughes
requested review from
a team and
vedanshujain
and removed request for
a team
| - **Internally Used**: Primarily intended for internal use within WooCommerce, such as powering the Analytics section in the admin dashboard. | ||
| - **Non-Versioned**: Currently, it does not use versioning, allowing WooCommerce developers to make changes as needed to support analytics features. | ||
|
|
||
| To use the `/wc-analytics` API, you must enable WooCommerce Analytics in your store's settings. Although it is not part of the public API like `/wc/v3`, it can still be accessed and used for custom development and integrations. |
There was a problem hiding this comment.
I suppose we are marking this public API if we allow it to be used for custom development.
| ``` | ||
|
|
||
| ```javascript | ||
| WooCommerce.get("reports") |
There was a problem hiding this comment.
are we upgrading the SDKs as part of this PR, or is this something that automatically happens?
There was a problem hiding this comment.
I think we don't need to upgrade the SDKs, I've added in the doc that we need to use wc-analytics instead of wc/v3 when specifying version in the SDK settings. The code examples were also added for setting for all languages, here's the PHP one.
I tried locally using PHP, Python, and Node.js and they can get the results under /wc-analytics namespace.
| ```json | ||
| [ | ||
| { | ||
| "slug": "performance-indicators", |
There was a problem hiding this comment.
should we document all properties as well for these reports?
There was a problem hiding this comment.
Thanks for the suggestion, I will add them in the upcoming PRs. Added as todo tasks it in the epic issue, along with the APIs for Import/Export as well: #248
|
Hi @vedanshujain, thanks for reviewing. I have updated the docs according to your suggestions, it's ready for another look. |
There was a problem hiding this comment.
(optional) We seem to be repeating the pagination args, maybe we can move to it's own section
There was a problem hiding this comment.
Thanks for the suggestion, I will work on it in the upcoming PRs.
Part of #248. This PR intends to merge into a feature branch feature/add-wc-analytics-reports-api-doc.
This PR adds products and product stats APIs to the analytics doc:
wc-analyticslink inwc/v3introduction./wc-analytics/reports/products)/wc-analytics/reports/products/stats)@woocommerce/proton Can you help on reviewing the structure of the API doc? The content will be reviewed by @woocommerce/automata. Thank you.
Detailed test instruction
./build.shbuild/index.htmlAnalytics docs