Search Analysis Groups

Search for an existing Analysis Group.


HTTP Request


Query Parameters





Query string to be matched against Group name.

E.g. ?q=MyAnalysisGroup

status string optional

Comma separated list (<status1>,<status2>) used to filter Analysis Groups by their status. Possible values:

  • active

  • deleted

E.g. ?status=deleted,active

sort string optional

Comma separated list (<sort1>,<sort2>) used to sort Analysis Groups. Possible values:

  • name - Sort by name A-Z

  • -name - Sort by name Z-A

  • created - Sort by created date oldest to newest

  • -created - Sort by created date newest to oldest

  • updated - Sort by updated date earliest to latest

  • -updated - Sort by updated date latest to earliest

E.g. ?sort=name,created

limit number optional

Limits the length of the returned list. The default limit is 10. E.g. ?limit=20

offset number optional

Specifies starting offset of the returned list. The default offset is 0. E.g. ?offset=3


Response Fields


count number

Total number of results found.

groups array

List of results where each item is an Analysis Group.

Please refer to the response fields section in Get an Analysis Group for the structure of each record.

Example response

Below is an example response:

    "count": 1,
    "groups": [
            "name": "My Analysis Group 1",
            "create_dt": "2024-02-26T20:58:27.746530+00:00",
            "update_dt": "2024-02-26T20:58:27.746530+00:00",
            "analysis_ids": [
            "processing_completed": {
                "feature_importance": true,
                "excluded_analyses": []
            "status": "active",
            "readiness_status": "ready",
            "user_id": null,
            "processed_dt": "2024-02-26T20:58:29.933984+00:00",
            "group_id": "-NjWQkYXsng"


curl -X GET \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

Last updated

© 2024 PredictHQ Ltd