# Generate screen view from feed - Operation ID: `generateScreenViewByFeedGetV2` - HTTP method: `GET` - Path: `/schema-service/v3/screen-views/{feedSlug}/generate` - [Human-readable API reference](https://hub.synerise.com/api-reference/asset-management#operation/generateScreenViewByFeedGetV2) ## Self-contained OpenAPI method The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required. ```yaml openapi: 3.0.0 info: title: Synerise Public API version: 1.9.5 paths: /schema-service/v3/screen-views/{feedSlug}/generate: get: tags: - Screen views summary: Generate screen view from feed description: | When this method is called, the Synerise backend finds all screen view campaigns applicable to the JWT context and returns the screen view with the highest priority (1). Inserts are processed. If an insert can't be processed, the returned `data` is empty. **IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only screen views with the audience set to `ALL` ("Everyone" in the Synerise Web Application) can be generated. If the feed doesn't contain any screen views whose audience matches the JWT context of the request, the response is error 404. --- **API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile **API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ` **User role permission required:** `assets_docs: read` operationId: generateScreenViewByFeedGetV2 security: - JWT: [] - BasicAuth: [] parameters: - in: path name: feedSlug description: Slug of the screen view feed required: true schema: type: string responses: "200": description: Processed JSON content content: application/json: schema: type: object required: - id - hash - priority - name - createdAt - updatedAt - audience - data - path properties: id: type: string format: uuid description: UUID of the screen view hash: type: string format: uuid description: UUID of the screen view priority: type: integer description: Priority determines which screen view to show to a customer if their profile matches the conditions of more than one screen view. `1` is the highest priority. default: 99 name: type: string description: Name of the screen view createdAt: type: string description: Creation date format: date-time updatedAt: type: string format: date-time description: Last update time audience: type: object description: The profiles (clients) which have access to this resource required: - targetType properties: targetType: type: string description: | The method of defining the audience: - SEGMENT sets the audience to segmentations whose UUIDs are provided in `segments` - QUERY sets the audience to an analytics query provided in `query` - ALL sets the audience to all profiles in the database enum: - SEGMENT - QUERY - ALL segments: type: array description: "An array of segmentation IDs. Used with `targetType: SEGMENT`" items: type: string query: type: string description: "Stringified `analysis` object for the segmentation analytics engine. Used with `targetType: QUERY`. Refer to the [Analytics API Reference](https://developers.synerise.com/#operation/addSegmentationPOST_v2)." example: '{"analysis":{"title":"Unnamed segmentation","description":"","unique":true,"segments":[{"title":"Segmentation A","description":"","filter":{"matching":true,"expressions":[{"_id":"a9b76c8e-34bd-4ac3-be8f-f37041d126bd","name":"","type":"FUNNEL","matching":true,"funnel":{"_id":"5c759d73-49c6-409f-96a3-b569dff8f8ff","title":"Unnamed","completedWithin":null,"dateFilter":{"type":"RELATIVE","offset":{"type":"DAYS","value":0},"duration":{"type":"DAYS","value":30}},"steps":[{"_id":"78b97ae0-1bc5-45fb-82a4-4f1280cfbdff","title":"","action":{"id":944,"name":"page.visit"},"eventName":"page.visit","expressions":[]}],"exact":false}}]}}]}}' data: type: object description: The JSON structure of the screen view, with inserts processed properties: collection: type: array description: By default, the `collection` property exists in each screen view, unless the default content was overwritten. This property's value is the output of the `{% screenviewcollection %}` insert. If you moved the insert into a different position in the JSON structure, its result (the array) will be stored at the position where you placed the insert (you can modify the screen definition so that the insert is under a key different than `collection`). items: type: object description: Processed document required: - id - slug - schema - content properties: uuid: type: string format: uuid description: UUID of the document slug: type: string description: Slug of the document example: basket pattern: "[a-z0-9]+(?:-[a-z0-9]+)*" schema: type: string description: Schema of the document (called "Type" in the Synerise Web Application) example: containers content: description: Content of the document anyOf: - type: object description: The processed JSON content of the document additionalProperties: description: JSON keys in the document and their values example: someBoolean: true someString: Lorem ipsum aNestedDocument: uuid: 772d94f7-a604-409a-bfa9-24a64b8a5051 slug: apple schema: fruit content: color: red - type: string description: Processed string value of a document (for example, a small document which only includes an insert to return an expression result) additionalProperties: description: Other JSON entities included in the screen view's JSON structure. path: type: string description: Address of the screen view definition example: /v2/screen-views/f9215cb9-4a7e-410b-88cb-8bc40363cc10 "400": description: See error message for details content: application/json: schema: type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: | Code of the error, needed for troubleshooting See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html) status: type: integer description: Error's HTTP status code message: type: string description: Description of the problem "401": description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc." content: application/json: schema: type: object properties: timestamp: type: string description: Time when the error occurred error: type: string description: Summary of the error message: type: string description: Description of the problem status: type: integer format: int32 description: HTTP status code "403": description: Forbidden; insufficient permissions content: application/json: schema: type: object properties: timestamp: type: string description: Time when the error occurred error: type: string description: Summary of the error message: type: string description: Description of the problem status: type: integer format: int32 description: HTTP status code "404": description: Resource not found content: application/json: schema: type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: | Code of the error, needed for troubleshooting See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html) status: type: integer description: Error's HTTP status code message: type: string description: Description of the problem "500": description: See error message for details content: application/json: schema: type: object properties: timestamp: type: string format: date-time description: Time when the error occurred errorCode: type: string description: | Code of the error, needed for troubleshooting See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html) status: type: integer description: Error's HTTP status code message: type: string description: Description of the problem x-snr-doc-urls: - /api-reference/loyalty-and-engagement#tag/Screen-views/operation/generateScreenViewByFeedGetV2 x-codeSamples: - lang: cURL label: cURL source: |- curl --request GET \ --url https://api.synerise.com/schema-service/v3/screen-views/%7BfeedSlug%7D/generate \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Python label: Python source: |- import http.client conn = http.client.HTTPSConnection("api.synerise.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/schema-service/v3/screen-views/%7BfeedSlug%7D/generate", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: JavaScript label: JavaScript source: |- const data = null; const xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) { console.log(this.responseText); } }); xhr.open("GET", "https://api.synerise.com/schema-service/v3/screen-views/%7BfeedSlug%7D/generate"); xhr.setRequestHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); xhr.send(data); - lang: Node.js label: Node.js source: |- const http = require("https"); const options = { "method": "GET", "hostname": "api.synerise.com", "port": null, "path": "/schema-service/v3/screen-views/%7BfeedSlug%7D/generate", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); - lang: PHP label: PHP source: |- setUrl('https://api.synerise.com/schema-service/v3/screen-views/%7BfeedSlug%7D/generate'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Java label: Java source: |- HttpResponse response = Unirest.get("https://api.synerise.com/schema-service/v3/screen-views/%7BfeedSlug%7D/generate") .header("Authorization", "Basic REPLACE_BASIC_AUTH") .asString(); servers: - url: https://api.synerise.com description: Microsoft Azure EU - url: https://api.azu.synerise.com description: Microsoft Azure USA - url: https://api.geb.synerise.com description: Google Cloud Platform tags: - name: Screen views components: securitySchemes: JWT: type: http scheme: bearer description: | Synerise uses [JSON Web Token (JWT)](https://jwt.io/) as the authorization method. The token is generated by the *auth/login* endpoints. You need to include it in the `Authorization` header of your requests, with a `Bearer` prefix. By default, the token is valid for **one week** (see [workspace settings](https://hub.synerise.com/docs/settings/tool/iam-for-apps/general/#jwt-lifetime)). You can request a refreshed key for the session by using the *auth/refresh* endpoint **before** the current token expires. You can verify your JWT signature by using the [public key](https://api.synerise.com/v4/public.pem). See Developer Guides on JWT API authentication for: - [profiles](https://hub.synerise.com/developers/api/api-authorization/client-login/); - [workspaces](https://hub.synerise.com/developers/api/api-authorization/workspace-login/#api-authentication-with-jwt); - [users](https://hub.synerise.com/developers/api/api-authorization/user-login/). BasicAuth: type: http scheme: basic description: | Basic authentication with login (workspace GUID) and password (workspace API key) encoded with Base64 and sent in the `Authorization` header. **Must be enabled in the settings of the API key**. This is less secure than JWTs. Limit the API key permissions to only those that you need. Consider API key rotation and other security measures. You can still use JWTs from the same API key when basic authentication is enabled. For details, see ["Workspace authentication"](https://hub.synerise.com/jwt-or-basic/#basic-api-authentication-with-api-keys). ```