Get Multiple Rules

Retrieves one or more rules.

Request

GET /rules?page=Page Number&page_size=Items Per Page

Request query string parameters:

Pass the following request query string parameters:

Response

A successful request returns a 200 OK response that contains the following properties:

items List

The items list describes each rule configuration via the following properties:

Sample Request/Response

Call the get_multiple_rules module (Python 3) to retrieve multiple rules. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams

class Rule:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        self._get_multiple_rules()

    def _get_multiple_rules(self):
        url = "{}{}".format(self.host, "/api/v4/rules")

        headers = {'Content-Type': 'application/json'}

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({}), headers=headers
        )

        print(response.json())

Rule().run()

Response:

{
	'@id': '/api/v4/rules',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/rules/abce337d51f04b6da043cc7f28c9fe2f',
			'@type': 'Rule',
			'id': 'abce337d51f04b6da043cc7f28c9fe2f',
			'created': '2021-07-01T20:45:59.171Z',
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'external_id': '',
			'audience': 'e1fa7c93edda4541937899ad032b9051',
			'alternate_content_type': 'slate',
			'alternate_content_id': '',
			'alternate_content_loop': True,
			'all_viewers': False,
			'desc': 'audiences'
		}, {
			'@id': '/api/v4/rules/72511122bf2541728641aefe7b4e58fe',
			'@type': 'Rule',
			'id': '72511122bf2541728641aefe7b4e58fe',
			'created': '2021-07-01T20:30:04.122Z',
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'external_id': '',
			'audience': '',
			'alternate_content_type': 'slicer',
			'alternate_content_id': 'slicer1',
			'alternate_content_loop': False,
			'all_viewers': True,
			'desc': 'allviewersslicer'
		}
	],
	'total_items': 2
}