Request description #

Path:/openapi/v1/{app_id}/cohorts/{cohort_id}
Method: PATCH
Content-type: application/json

Request parameters #

Path-parameters:

Body:
Modify to create clusters by uploading files:

{
    "cohort_name": "cohort name",
    "cohort_type": 2, //2 means cohorts of file upload type
    "description": "cohort description",
    "dsl_content": {
        "uuid_file_key": "upload_uuid/164314/20220819/1eb8f3c6-4447-4e9c-a538-c1b33a1cd0e4.csv", 
        // uuid_file_key can be acquired after upload files through 9.1 interface
        "file_list": [
            {
                "name": "user_unique_id_template (3).csv" //upload file name
            }
        ],
        "dsl_type": "user_unique_id" // support user_unique_id、ssid、device_id、web_id
    },
    "refresh_rule": 1
}

Modify the rule to create a cluster:

{
    "cohort_name": "cohort name",
    "cohort_type": 4 //4 means cohorts of rule upload type
    "description": "cohort description",
    "dsl_content": {},
    "refresh_rule": 1
}

return parameters #

Response:

{
    "code": 200,
    "message": "success",
    "data": null
}

Request example #

Bc for the creation of RangersClient, its initialization please refer to Instructions for use the language SDK provides a similar interface.
Call (Python):

# for example, app_id= 164314 cohort id= 1001076
body = {
    "cohort_name": "openapi-modify",
    "cohort_type": 4, //4 means rule creation
    "description": "",
    "dsl_content": {
        "periods": [],
        "app_ids": [
            164314
        ],
        "content": {
            "profile_filters": [],
            "profile_groups": [],
            "queries": [
                [
                    {
                        "show_label": "event--A--A",
                        "event_name": "any_event",
                        "event_type": "origin",
                        "next_query_label": null,
                        "sequence_first": true,
                        "logic": true,
                        "condition": {
                            "property_operation": ">",
                            "property_values": [
                                0
                            ],
                            "period": {
                                "granularity": "day",
                                "last": {
                                    "amount": 7,
                                    "unit": "day"
                                },
                                "type": "last",
                                "timezone": "Asia/Shanghai"
                            }
                        },
                        "filters": [
                            {
                                "expression": {
                                    "logic": "and",
                                    "conditions": []
                                }
                            }
                        ],
                        "event_indicator": "events"
                    }
                ]
            ],
            "query_type": "$cohort"
        },
        "version": 3
    },
    "refresh_rule": 2 # modify from 1 to 2
}
resp = bc.data_finder("/openapi/v1/164314/cohorts/1001076"， body=dsl)
cohort_id = resp.json()["data"]["cohort_id"]

Back to example #

Return result:

{
    "code": 200,
    "message": "success",
    "data": {
        "cohort_id": 1001076
    }
}