List Affected Users.

POST

/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/affectedUsers

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/csd/namespaces/example/scripts/example/affectedUsers \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "filters": { "affected_user_device_id_filter": { "device_ids": [ "example" ], "op": "IN" }, "affected_user_geolocation_filter": { "geolocations": [ "example" ], "op": "IN" }, "affected_user_ip_address_filter": { "ip_addresses": [ "example" ], "op": "IN" } }, "namespace": "example", "page_number": 1, "page_size": 1, "page_token": "example", "script_id": "example", "sorts": [ { "field": "example", "order": "DESCENDING" } ], "start_time": "example" }'

• F5 Distributed Cloud Console

List affected users who have loaded this particular script.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace.

script_id

required

string

Script_id x-required ID of the script.

Request Body^required

Media typeapplication/json

ListAffectedUsersRequest

Request to list affected users who have loaded this particular script.

object

end_time

end_time

Format: unix epoch timestamp in seconds fetch affected users whose last seen time <= end_time Required: YES.

string

<= 1024 characters

filters

object

affected_user_device_id_filter

object

device_ids

device_ids

An unordered list of device IDs Required: YES.

Array<string>

>= 1 items <= 64 items

op

string

default: IN

Allowed values: IN

affected_user_geolocation_filter

object

geolocations

geolocations

An unordered list of geolocations Required: YES.

Array<string>

>= 1 items <= 64 items

op

string

default: IN

Allowed values: IN

affected_user_ip_address_filter

object

ip_addresses

ip_addresses

An unordered list of IP addresses Required: YES.

Array<string>

>= 1 items <= 64 items

op

string

default: IN

Allowed values: IN

namespace

namespace

Namespace

string

>= 6 characters <= 1024 characters

page_number

page_number

One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.

integer format: int32

page_size

page_size

The maximum number of affected users to return per page.

integer format: int32

page_token

page_token

Page_token is the value of listaffectedusersresponse.next_page_token from previous request.

string

<= 512 characters

script_id

script_id

ID of the script Required: YES.

string

<= 1024 characters

sorts

sorts

Additional sort criteria.

Array<object>

Sort

API query sort criteria.

object

field

Sort field

Field specification or configuration

string

<= 1024 characters

order

string

default: DESCENDING

Allowed values: DESCENDING ASCENDING

start_time

start_time

Format: unix epoch timestamp in seconds fetch affected users whose last seen time >= start_time Required: YES.

string

<= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

ListAffectedUsersResponse

Response to list affected users who have loaded this particular script.

object

affected_users

affected_users

List of affected users.

Array<object>

AffectedUser

Information about the affected user.

object

channel

channel

Channel of access to script by affected user.

string

<= 1024 characters

device_id

device_id

Device ID of the affected user.

string

<= 1024 characters

geolocation

Geolocation

Geolocation of the affected user.

string

<= 1024 characters

ip_address

ip_address

IP address of the affected user.

string

<= 1024 characters

last_seen

last_seen

Format: unix epoch timestamp in milliseconds Last seen time.

string

<= 1024 characters

user_agent

user_agent

User agent of affected user.

string

<= 1024 characters

next_page_token

next_page_token

Opaque value passed back alone with the additional calls. All filtering will stay the same.

string

<= 1024 characters

page_number

page_number

One-indexed page number.

integer format: int32

page_size

page_size

The maximum number of affected users to return per page.

integer format: int32

total_count

total_count

Total count of affected users available at time of query, and subject to change across queries.

integer format: int32

total_pages

total_pages

Total number of pages available depending upon requested page_size.

integer format: int32

Example^generated

{
  "affected_users": [
    {
      "channel": "example",
      "device_id": "example",
      "geolocation": "example",
      "ip_address": "example",
      "last_seen": "example",
      "user_agent": "example"
    }
  ],
  "next_page_token": "example",
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "total_pages": 1
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example