Thingworx Analytics Best Practices

[vieirac1]

Hello Team,

We are doing some tests with Thingworx Analytics 9 and have the following questions:

1. Is there any better guide or best practices document on how to use the Thingworx Analytics APIs?

2. We also ran a test where we created a model training job on analytics server thru the API, we have confirmed the job completion using the API, but we can´t see the model in the Analytics Builder UI – anything we need to include in the API so we can see the model in the Analytics Builder UI?

3. Do we have any examples of Thingworx Analytics API calls and use cases?

Tks,
Chris

[nsampat]

@vieirac1 ,

I believe you also opened a case for this inquiry, and I have reached out to you on that case.

I will copy and paste the info I sent you in the email for the case here as well:

• Is there any better guide or best practices document on how to use the Thingworx Analytics APIs?
  • The ThingWorx Platform API Guide contains the best practices to follow:
    ThingWorx Platform API Guide: https://support.ptc.com/help/thingworx/platform/r9/en/index.html#page/ThingWorx/Help/REST_API/ThingWorxRESTAPI.html
  • ThingWorx Analytics Specific API document can be found here: https://support.ptc.com/help/thingworx/analytics/r9/en/#page/analytics/twxa-api/twxa-api-overview.html#
• We also ran a test where we created a model training job on analytics server thru the API, we have confirmed the job completion using the API, but we can´t see the model in the Analytics Builder UI – anything we need to include in the API so we can see the model in the Analytics Builder UI?
  • This is working as designed as there are extra flags that need to be included in the message to see API submitted datasets and jobs in builder. If a client wishes to use Builder, it is recommended they submit and perform all work via the UI. Jobs submitted by API cannot be modified or transformed in the UI as there are additional processes such as Validation sets and backend services that need to create additional references. Clients will not see any visualizations created from API Submitted jobs in Builder either. It is recommended that the client choose to stick with API only, or with the UI only, as using both is not a best practice for ThingWorx Analytics.
• Do we have any examples of Thingworx Analytics API calls and use cases?
  • Technical support does not support use cases, and often these types of discussions are handled by the Field Services team at PTC. I can refer you to the PTC Community posts, but I cannot provide any use cases or samples directly.
  • Here is a demo with sample services created by one of our Field Services Professionals: https://community.ptc.com/t5/IoT-Tech-Tips/Analytics-Services-Examples/td-p/724778

Please let me know if this provides the requested info by marking this comment as "Solution Accepted"

Regards,

Neel