Skip to content

experienceGroups.md

Latest commit

 

History

History
94 lines (67 loc) · 3.72 KB

experienceGroups.md

File metadata and controls

94 lines (67 loc) · 3.72 KB

Experience Groups Actions

Details on the various actions that can be performed on the Experience Groups resource, including the expected parameters and the potential responses.

Contents

Get

Returns the experience groups for an application

result = client.experience_groups.get(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceGroups.*, or experienceGroups.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*group
query Advanced Experience Group Query N Experience group filter JSON object which overrides the filter and filterField fields. Advanced Experience Group Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Groups Collection of experience groups

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new experience group for an application

result = client.experience_groups.post(
    applicationId=my_application_id,
    experienceGroup=my_experience_group)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceGroups.*, or experienceGroups.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceGroup Experience Group Post Y New experience group information Experience Group Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Experience Group Successfully created experience group

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found