Prepr

https://docs.prepr.io
Admin
Prepr is a headless content management system (CMS) offering tools for content modeling, management,...
Tokens:214,628
Snippets:3,438
Trust Score:9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve Guide by ID

Source: https://docs.prepr.io/integrations/prepr-for-radio/guides-query-by-id

Use this HTTP GET request to fetch guide details for a specific ID.

```http
GET: https://radio-api.prepr.io/v5/guides/{id}
```

--------------------------------

### Install Prepr Node.js SDK

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Install the required SDK package via npm.

```bash
npm install @preprio/nodejs-sdk
```

--------------------------------

### GET https://radio-api.prepr.io/v5/guides

Source: https://docs.prepr.io/integrations/prepr-for-radio/guides-query-a-collection

Retrieves a collection of guides from the Prepr for Radio API.

```APIDOC
## GET https://radio-api.prepr.io/v5/guides

### Description
Retrieves a collection of guides, which are collections of ShowSchedules on a specified day or time.

### Method
GET

### Endpoint
https://radio-api.prepr.io/v5/guides

### Parameters
#### Query Parameters
- **q** (String) - Optional - Search by name.

### Response
#### Success Response (200)
- **items** (Array) - List of guide objects
- **total** (Number) - Total number of items
- **after** (String) - Cursor for pagination
- **before** (String) - Cursor for pagination
- **skip** (Number) - Number of items skipped
- **limit** (Number) - Limit of items returned

#### Response Example
{
    "items": [
        {
            "id": "7fbf1458650-22af-4b64-9e13-9bc26a4543032",
            "created_on": "2018-06-07T07:35:04+00:00",
            "changed_on": null,
            "label": "Guide",
            "body": "Prepr Clocks"
        }
    ],
    "total": 3,
    "after": "YWZ0ZXJfMjU=",
    "before": "YmVmb3JlXzA=",
    "skip": 0,
    "limit": 25
}
```

--------------------------------

### Query Guides Endpoint

Source: https://docs.prepr.io/integrations/prepr-for-radio/guides-query-a-collection

Use this HTTP GET request to retrieve the collection of guides.

```http
GET: https://radio-api.prepr.io/v5/guides
```

--------------------------------

### Install project dependencies

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Install Express, nodemon, and dotenv packages.

```bash
npm install express nodemon dotenv
```

--------------------------------

### Guide Response Structure

Source: https://docs.prepr.io/integrations/prepr-for-radio/guides-query-by-id

Example JSON response structure for a guide query, showing schedule rules, show details, and scheduled users.

```json
{
    "2018-07-04": [
        {
            "from": "00:00:00",
            "until": "02:00:00",
            "offset": 0,
            "limit": 7200,
            // Rule that created this schedule
            "rules": {
                "id": "e165d807-bab2-488-a247-00db27397c72",
                "created_on": "2018-06-07T07:35:28+00:00",
                "changed_on": "2018-06-12T17:51:45+00:00",
                "label": "ShowSchedule",
                "offset": 0,
                "limit": 7200,
                "valid_from": "2018-06-04",
                "valid_until": null,
                "exception": false,
                "days": [
                    "1",
                    "2",
                    "3",
                    "4",
                    "5"
                ]
            },
            // Program Scheduled
            "show": {
                "id": "58f9f68f-c35-4dd0-9055-e95dbdf3d139",
                "created_on": "2018-06-12T17:27:36+00:00",
                "changed_on": "2018-06-26T08:17:02+00:00",
                "published_on": "2018-06-26T08:17:01+00:00",
                "unpublish_on": null,
                "label": "Show",
                "status": "published",
                "slug": null,
                "body": "",
                "name": "Star Morning Show"
            },
            // Scheduled users in this episode
            "users": {
                // Tag ID (type of scheduling like DJ, Producer, Newsreader) 
                "586643d3-0c02-43fe-80bf-fba9590aa41b": [
                    {
                        "id": "97926b24-75c8-40d6-bf5-779d8ec77548",
                        "created_on": "2018-06-12T17:46:05+00:00",
                        "changed_on": "2018-06-12T17:51:39+00:00",
                        "last_seen": "2018-06-12T17:46:05+00:00",
                        "label": "Person",
                        "preposition": "",
                        "initials": "",
                        "firstname": "Carolien",
                        "prefix_lastname": "",
                        "lastname": "de Bruijn",
                        "nickname": null,
                        "tracking": true
                    },
                    {
                        "id": "d06fc0d7-ccd3-4467-bd0c-6bd97341fbbf",
                        "created_on": "2018-06-12T17:46:19+00:00",
                        "changed_on": null,
                        "last_seen": "2018-06-12T17:46:19+00:00",
                        "label": "Person",
                        "preposition": "",
                        "initials": "",
                        "firstname": "Paul",
                        "prefix_lastname": "",
                        "lastname": "Kronenburg",
                        "nickname": null,
                        "tracking": true
                    }
                ]
            }
        }
        // ..... more
    ]
}
```

--------------------------------

### Install Prepr SDK via Composer

Source: https://docs.prepr.io/laravel/laravel-rest-provider

Use these commands to install the appropriate SDK version based on your Laravel project version.

```bash
composer require preprio/laravel-rest-sdk:"^4.0"
```

```bash
composer require preprio/laravel-rest-sdk:"^2.0"
```

```bash
composer require preprio/laravel-rest-sdk:"^1.3"
```

```bash
composer require preprio/laravel-rest-sdk:"1.1"
```

--------------------------------

### Run the application

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Command to start the application using the watch script.

```bash
npm run watch
```

--------------------------------

### Install PHP REST SDK

Source: https://docs.prepr.io/php/php-rest-sdk

Use Composer to add the SDK to your project.

```bash
composer require preprio/php-rest-sdk
```

--------------------------------

### Install and run GraphQL Schema Diff

Source: https://docs.prepr.io/graphql-api/diagnostic-tools

Install the tool globally and use it to compare two different GraphQL API endpoints.

```bash
npm install -g graphql-schema-diff
```

```bash
graphql-schema-diff <SCHEMA-1-API-ENDPOINT> <SCHEMA-2-API-ENDPOINT> -s
```

--------------------------------

### GET https://radio-api.prepr.io/v5/guides/{id}

Source: https://docs.prepr.io/integrations/prepr-for-radio/guides-query-by-id

Retrieves a collection of ShowSchedules for a specified guide ID.

```APIDOC
## GET https://radio-api.prepr.io/v5/guides/{id}

### Description
Retrieves a collection of ShowSchedules for a specified guide ID.

### Method
GET

### Endpoint
https://radio-api.prepr.io/v5/guides/{id}

### Parameters
#### Path Parameters
- **id** (String) - Required - The unique identifier of the guide.

#### Query Parameters
- **from** (String) - Optional - Start date in YYYY-MM-DD format.
- **until** (String) - Optional - End date in YYYY-MM-DD format.
- **exceptions** (Boolean) - Optional - Set to TRUE for production environments.
- **show.id** (String) - Optional - Filter guides for a specified Show ID.

### Response
#### Success Response (200)
- **Response Body** (Object) - A collection of ShowSchedules keyed by date.
```

--------------------------------

### GET https://customers.prepr.io/

Source: https://docs.prepr.io/mutation-api/customers

Fetch a collection of all customers.

```APIDOC
## GET https://customers.prepr.io/

### Description
Fetch a collection of all customers.

### Method
GET

### Endpoint
https://customers.prepr.io/
```

--------------------------------

### Install GraphQL Schema Diff tool

Source: https://docs.prepr.io/llms-full.txt

Install the global npm package to enable schema comparison functionality.

```bash
npm install -g graphql-schema-diff
```

--------------------------------

### Resized Asset Response Example

Source: https://docs.prepr.io/mutation-api/assets-resizing

Example of the JSON response structure containing the original URL and the requested resized image URLs.

```json
{
  // Particle response of /assets endpoint.
  "cdn_files": {
    "total": 1,
    "items": [
      {
        "id": "bfaac48b-fb0d-4d12-84da-af8d65244c4b",
        "created_on": "2023-06-12T08:44:43+00:00",
        "label": "CdnFile",
          "file": "371apne44zy3.jpg",
          "url": "https://example.stream.prepr.io/{format}/371apne44zy3-5az.jpg"
        "resized": {
          "landing": "https://example.stream.prepr.io/w_232,h_232/371apne44zy3.jpg",
          "thumb": "https://example.stream.prepr.io/w_123,h_123/371apne44zy3.jpg"
        }
      }
    ]
  }
}
```

--------------------------------

### GET /content_items

Source: https://docs.prepr.io/llms-full.txt

Fetches a collection of content items.

```APIDOC
## GET /content_items

### Description
Fetches a collection of content items for bulk processing or retrieval.

### Method
GET

### Endpoint
https://cdn.prepr.io/content_items
```

--------------------------------

### GET https://mutation.prepr.io/publications/algolia/sync

Source: https://docs.prepr.io/llms-full.txt

Syncs content items to Algolia manually for a specified model ID.

```APIDOC
## GET https://mutation.prepr.io/publications/algolia/sync

### Description
Syncs content items to Algolia manually. This is used to index existing content or content after a schema update.

### Method
GET

### Endpoint
https://mutation.prepr.io/publications/algolia/sync

### Request Body
- **model** (object) - Required - The model object containing the ID of the content model to sync.
  - **id** (string) - Required - The Model ID found under Schema → Model.

### Request Example
{
   "model": {
       "id": "YOUR_MODEL_ID"
   }
}
```

--------------------------------

### DateTime and DateTimeRange API Structures

Source: https://docs.prepr.io/llms-full.txt

Examples of standard date fields and range-based date fields with optional time components.

```json
"created_on": "2023-01-01T16:28:21+00:00",
                "changed_on": null,
                "label": "DateTime",
                "value": "2023-01-01 18:25:00",
                "format": "Y-m-d H:i:s"
            },
              "project_duration": { 
                // The API Id of a date field with ranges
                "id": "abb46555-013f-4e2e-871e-344b243332f6",
                "created_on": "2023-01-01T16:25:53+00:00",
                "changed_on": null,
                "label": "DateTimeRange",
                "from": "2023-01-01",
                "until": "2024-12-31",
                "format": "Y-m-d"
            },
            "event_duration": { 
                // The API Id of a date field with ranges including time
                "id": "efd799d9-ee9d-4ec1-8cc3-487b1ecb347a",
                "created_on": "2023-01-01T16:25:53+00:00",
                "changed_on": null,
                "label": "DateTimeRange",
                "from": "2023-01-01 00:00:00",
                "until": "2024-12-31 23:59:59",
                "format": "Y-m-d H:i:s"
            }
```

--------------------------------

### Create Services Directory and File

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Commands to set up the directory structure for the Prepr service.

```bash
mkdir services
cd services
touch prepr.js
```

--------------------------------

### Copy environment configuration

Source: https://docs.prepr.io/connecting-a-front-end-framework/nextjs/caching-strategies

Initializes the environment variables file from the provided example template.

```bash
cp .env.example .env
```

--------------------------------

### prepr('event', 'SignUp')

Source: https://docs.prepr.io/llms-full.txt

Tracks when a visitor creates a new account.

```APIDOC
## prepr('event', 'SignUp')

### Description
Tracks account registration. This event prevents the visitor from being deleted after 90 days of inactivity.
```

--------------------------------

### Initialize Node.js project directory

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Commands to create and enter the project directory.

```bash
mkdir prepr-node
cd prepr-node
```

--------------------------------

### Configure Prepr Client

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Initialize the Prepr client using environment variables for authentication.

```js
require("dotenv").config();
const { createPreprClient } = require("@preprio/nodejs-sdk");

const prepr = createPreprClient({
  token: process.env.PREPR_ACCESS_TOKEN, // You can find one in your Prepr environment
  baseUrl: "https://graphql.prepr.io/graphql",
  userId: null, // Optional, used for AB testing implmentations
});

module.exports = { prepr };
```

--------------------------------

### Article URL structure example

Source: https://docs.prepr.io/quick-start-guide

Example of a unique URL constructed using the article slug.

```text
https://yourdomain.com/articles/how-to-get-the-best-deals-insider-tips-and-tricks
```

--------------------------------

### POST https://mutation.prepr.io/assets (Video Start)

Source: https://docs.prepr.io/mutation-api/assets-upload-update-and-destroy

Initializes a resumable upload session for a video file.

```APIDOC
## POST https://mutation.prepr.io/assets

### Description
Initializes a new video upload session.

### Method
POST

### Endpoint
https://mutation.prepr.io/assets

### Response
#### Success Response (200)
- **id** (string) - The auto-generated ID for the video upload session
```

--------------------------------

### Create Queries Directory and File

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Commands to set up the directory structure for GraphQL queries.

```bash
mkdir queries
cd queries
touch preprQueries.js
```

--------------------------------

### Initialize Express server with Prepr data fetching

Source: https://docs.prepr.io/connecting-a-front-end-framework/nodejs

Configures an Express application to fetch GraphQL data from Prepr on startup and serve it via the root path.

```javascript
const express = require("express");
const { prepr } = require("./services/prepr");
const { GetPosts } = require("./queries/preprQueries");

const app = express();
const port = process.env.PORT || 3000;

const posts = [];

const preprData = async () => {
 const postsData = await prepr.graphqlQuery(GetPosts).fetch();
 posts.push(...postsData.data.posts.items);
};

preprData();

// Query for the root path.
app.get("/", (req, res) => {
 res.send({ data: posts });
});

// Listen to application port.
app.listen(port, () => {
 console.log(`App listening at http://localhost:${port}`);
});
```

--------------------------------

### GET /tags

Source: https://docs.prepr.io/mutation-api/tags

Fetch all tags.

```APIDOC
## GET /tags

### Description
Fetch all tags.

### Method
GET

### Endpoint
/tags
```

--------------------------------

### prepr("init")

Source: https://docs.prepr.io/data-collection/recording-events

Initializes the Prepr tracking code and enables the Google Tag Manager destination.

```APIDOC
## prepr("init")

### Description
Initializes the Prepr tracking environment. By setting the `googleTagManager` destination flag to `true`, personalization events are automatically pushed to the GTM dataLayer.

### Parameters
- **token** (string) - Required - The Prepr project token.
- **options** (object) - Required - Configuration object containing `destinations`.

### Request Example
```js
prepr(
    "init",
    "abc123ecfff2385c9c4fe027d56ea7d544cee78b173",
    {
        destinations: {
            googleTagManager: true
        }
    }
);
```
```

--------------------------------

### GET /tag_groups

Source: https://docs.prepr.io/mutation-api/tags

Fetch all tag groups.

```APIDOC
## GET /tag_groups

### Description
Fetch all tag groups.

### Method
GET

### Endpoint
/tag_groups
```

--------------------------------

### Execute a raw GraphQL query

Source: https://docs.prepr.io/php/php-graphql-sdk

Initialize the Prepr client and execute a raw GraphQL query string.

```php
<?php

use Preprio\Prepr;

$apiRequest = new Prepr('{ENDPOINT_URL}');

$apiRequest
    ->rawQuery('{
                  Posts( limit : 30 ) {
                    items {
                        _id
                        _slug
                        title
                    }
                  }
                }')
    ->request();

print_r($apiRequest->getResponse());
```

--------------------------------

### Asset Changed Payload

Source: https://docs.prepr.io/development/best-practices/webhooks

Example payload object for an asset.changed event.

```json
{
  "id": "c8580913-bbac-4309-9f74-95a6835930b8",
  "created_on": "2025-03-19T16:01:14+00:00",
  "changed_on": "2025-05-27T15:23:33+00:00",
  "label": "Photo",
  "name": "bmw",
  "body": "",
  "author": "",
  "status": null,
  "replaceable": true,
  "reference_id": "b773b7b3-97ce-40c3-ae1f-b1369d0516e1",
  "reference": null,
  "original_name": "img",
  "mime_type": "image/png",
  "extension": "png",
  "height": 250,
  "width": 496
}
```

--------------------------------

### GET /assets/{id}

Source: https://docs.prepr.io/mutation-api/fetching-single-assets

Retrieves a single asset by its unique identifier.

```APIDOC
## GET /assets/{id}

### Description
Retrieves the details of a specific asset using its unique ID.

### Method
GET

### Endpoint
/assets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the asset.
```

--------------------------------

### Install the Prepr SDK

Source: https://docs.prepr.io/laravel/laravel-graphql-provider

Use Composer to add the Prepr GraphQL SDK to your Laravel project.

```bash
composer require preprio/laravel-graphql-sdk
```

--------------------------------

### GET https://customers.prepr.io/customers/me

Source: https://docs.prepr.io/mutation-api/customers-fetching-customer-profile

Retrieves the profile of the currently signed-in customer.

```APIDOC
## GET https://customers.prepr.io/customers/me

### Description
Retrieves the profile of the currently signed-in customer.

### Method
GET

### Endpoint
https://customers.prepr.io/customers/me

### Query Parameters
- **fields** (String) - Optional - Comma-separated list of fields to expand in the customer object (e.g., id, first_name, last_name, date_of_birth, email, phone, reference_id, tags, segments).

### Response
#### Success Response (200)
- **id** (String) - Customer ID
- **first_name** (String) - First name of the customer
- **last_name** (String) - Last name of the customer
- **date_of_birth** (String) - Date of birth (Y-m-d)
- **email** (String) - Email address
- **phone** (String) - Phone number
- **tags** (Array) - List of tags associated with the customer

#### Response Example
{
    "id" : "234h-432847-x23498-763x4-324x234",
	"first_name": "Jhon",
	"last_name": "Doe",
	"date_of_birth": "2000-12-01",
	"email": "jhon.doe@gmail.com",
	"phone": "31612345678",
    "tags": {
        "items": [
            {
                "body": "Amsterdam"
            }
        ]
    }
}
```

--------------------------------

### Configure environment variables

Source: https://docs.prepr.io/prepr-nextjs-package

Add the required Prepr GraphQL URL and environment setting to your .env file.

```bash
PREPR_GRAPHQL_URL=<YOUR-PREPR-GRAPHQL-URL>
PREPR_ENV=preview
```

--------------------------------

### GET /v5/publications

Source: https://docs.prepr.io/integrations/prepr-for-radio

Retrieves a list of publications from the Prepr for Radio platform.

```APIDOC
## GET /v5/publications

### Description
Retrieves a list of publications available in the Prepr for Radio system.

### Method
GET

### Endpoint
https://radio-api.prepr.io/v5/publications

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for your application.
```

--------------------------------

### GET /publications

Source: https://docs.prepr.io/integrations/prepr-for-radio/publications-query-a-collection

Fetch a collection of content items from the Prepr API.

```APIDOC
## GET /publications

### Description
Fetch a collection of content items.

### Method
GET

### Endpoint
/publications

### Parameters
#### Query Parameters
- **status** (String) - Optional
- **label** (String) - Optional
- **channel_id** (String) - Optional - Filter on specified channel
- **channel_ids** (String) - Optional - Filter on specified channels, comma-separated
- **q** (String) - Optional - Full text search
- **tag_ids** (String) - Optional
- **tag_names** (String) - Optional
- **sort** (String) - Optional - published_on, -published_on, created_on, -created_on, changed_on, -changed_on, name
- **created_by_id** (String) - Optional
- **published_on_from** (Integer) - Optional - UNIX Timestamp
- **published_on_until** (Integer) - Optional - UNIX Timestamp
- **tag_slug** (String) - Optional
- **channel_slug** (String) - Optional

### Response
#### Success Response (200)
- **items** (Array) - List of content items
- **total** (Integer) - Total count of items
- **after** (String) - Cursor for next page
- **before** (String) - Cursor for previous page
- **skip** (Integer) - Number of items skipped
- **limit** (Integer) - Limit of items returned

#### Response Example
{
    "items": [
        {
            "id": "a4452199a-24027-4071-ae22-ef4e2fca254a6",
            "created_on": "2017-06-08T09:27:59+00:00",
            "changed_on": "2017-08-25T08:14:49+00:00"
        }
    ],
    "total": 1,
    "after": "YWZ0ZXJfMjU=",
    "before": "YmVmb3JlXzA=",
    "skip": 0,
    "limit": 25
}
```
Tokens:
Raw