You're viewing an archived version of our docs. Check out our current documentation →

Batch action to multiple compositions

Adds, updates, or deletes compositions with a single API request.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
use Algolia\AlgoliaSearch\Api\CompositionClient;

$client = CompositionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

$response = $client->multipleBatch(
    ['requests' => [
        ['action' => 'upsert',
            'body' => ['objectID' => 'my-metadata-compo',
                'name' => 'my composition',
                'behavior' => ['injection' => ['main' => ['source' => ['search' => ['index' => 'foo',
                    'params' => ['filters' => 'brand:adidas',
                    ],
                ],
                ],
                ],
                    'injectedItems' => [
                        ['key' => 'injectedItem1',
                            'source' => ['search' => ['index' => 'foo',
                                'params' => ['filters' => 'brand:adidas',
                                ],
                            ],
                            ],
                            'position' => 2,
                            'length' => 1,
                            'metadata' => ['hits' => ['addItemKey' => true,
                                'extra' => ['my-string' => 'string',
                                    'my-bool' => true,
                                    'my-number' => 42,
                                    'my-object' => ['sub-key' => 'sub-value'],
                                ],
                            ],
                            ],
                        ],

                        ['key' => 'externalItem',
                            'source' => ['search' => ['index' => 'foo',
                                'params' => ['filters' => 'brand:puma',
                                ],
                            ],
                            ],
                            'position' => 5,
                            'length' => 5,
                            'metadata' => ['hits' => ['addItemKey' => true,
                                'extra' => ['my-string' => 'string',
                                    'my-bool' => true,
                                    'my-number' => 42,
                                    'my-object' => ['sub-key' => 'sub-value'],
                                ],
                            ],
                            ],
                        ],
                    ],
                ],
                ],
            ],
        ],
    ],
    ],
);