@Fae This is great.  But I'm having a couple of issues with the API on v4.4.3 of the controller.

• The path /api/v2/sites/{siteKey}/clients returns an error.  Has this been removed?
• The path /api/v2/sites/{siteKey}/insight/clients works, but only returns 10 clients.  The JSON shows:
  "currentPage": 1,
  "currentSize": 10,
  • How can the size and page be updated?  It doesn't appear to be covered in the API document.

Is there a place that we can find the updated API documentation (this should be published on the site somewhere)?

Thanks, the API documentation you provided has been a real help.

@Fae Thanks for the pointer to the API; excuse my ignorance, but where is the definition of the POST payloads?  For example for `login` API call?

Fae wrote

Dear @OneFix,

 

OneFix wrote

• The path /api/v2/sites/{siteKey}/clients returns an error.  Has this been removed?
• The path /api/v2/sites/{siteKey}/insight/clients works, but only returns 10 clients.  The JSON shows:
  "currentPage": 1,
  "currentSize": 10,
  • How can the size and page be updated?  It doesn't appear to be covered in the API document.

 

Just confirmed the information for you, here is the answer:

 

No, both paths haven't been adjusted/removed, but paging queries are required.

 

"currentPage" refers to the current page number, it is populated with 1 by default;

"currentPageSize" refers to the number of clients displaying on each page, and it's populated with 10 by default.

 

The above fields are not populated by default on the interface /api/v2/sites/{siteKey}/clients, so it returns an error.

 

I think you can modify the currentPage and currentSize to check more clients.

Thanks, the API document doesn't seem to mention the proper way to modify the currentPage and currentPageSize settings.

I seem to have gotten it working with the insights page.  For anyone interested, It is:

/api/v2/sites/{siteKey}/insight/clients?currentPageSize=999&currentPage=1 (there seems to be no upper limit on currentPageSize)

But, the interface /api/v2/sites/{siteKey}/clients still returns a "General Error" even when I add the currentPageSize and currentPage parameters.

Do you have any information on how to do this correctly?

Do you have a complete/functional v2 API document? Preferably a Swagger/OpenAPI version? The v2 API document referenced above contains the HTTP verbs and URLs but doesn't provide any of the JSON request payloads or example JSON responses. Thanks!

A complete OpenAPI document would be ideal - one can then generate a client from it.

ZdenekM wrote

A complete OpenAPI document would be ideal - one can then generate a client from it.

Agreed, that is actually what I was working on building (a Python module to be specific).

@Fae any update on complete API documentation?