Zenler Public API

https://www.newzenler.com/api/documentation/public/
Admin
Zenler Public API allows users to integrate their Zenler account with external applications,...
Tokens:35,465
Snippets:87
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /api/v1/reports/enrollments/brief

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a brief list of enrollments for specified courses within a date range.

```APIDOC
## GET /api/v1/reports/enrollments/brief

### Description
Retrieves a brief list of enrollments for specified courses within a date range.

### Method
GET

### Endpoint
https://api.newzenler.com/api/v1/reports/enrollments/brief

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **course_ids[]** (Array) - Optional - Specify course IDs

### Response
#### Success Response (200)
- **response_code** (Number) - Indicates the success of the operation.
- **message** (String) - A message describing the result of the operation.
- **data** (Object)
  - **items** (Array) - A list of enrollment items.
    - **course_id** (Number) - The ID of the course.
    - **course_name** (String) - The name of the course.
    - **no_of_enrollments** (Number) - The number of enrollments for the course.
  - **pagination** (Object) - Pagination details.
    - **total_items** (Number) - Total number of items available.
    - **items_per_page** (Number) - Number of items per page.
    - **page_index** (Number) - The current page index.
    - **total_pages** (Number) - Total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "course_id": 1156,
        "course_name": "test",
        "no_of_enrollments": 7
      }
    ],
    "pagination": {
      "total_items": 3,
      "items_per_page": 1,
      "page_index": 1,
      "total_pages": 3
    }
  }
}
```
```

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

### Get Brief Sales Report using cURL

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves aggregated sales data, grouped by course, day, or month. It requires start and end dates, and optionally accepts course IDs. The response includes total sales, earnings, and affiliate fees.

```bash
curl -X GET 'https://api.newzenler.com/api/v1/reports/sales/brief?start_date=2018-01-01&end_date=2018-12-31&limit=20&page=1&groupby=course&course_ids[]=1156' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### GET /api/v1/reports/affiliates/brief

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a brief report on affiliate performance, summarizing key metrics like total sales and commissions.

```APIDOC
## GET /api/v1/reports/affiliates/brief

### Description
Retrieves a brief report on affiliate performance. This endpoint summarizes key metrics such as total sales count, total commission earned, pending commission, and paid commission for affiliates.

### Method
GET

### Endpoint
`https://api.newzenler.com/api/v1/reports/affiliates/brief`

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18).
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18).
- **limit** (Number) - Optional - The number of items to be returned. Default: 15.
- **page** (Number) - Optional - The page within the collection to fetch. Default: 1.
- **course_ids[]** (Array) - Optional - Specify course ID(s) to filter the report.
- **affiliate_ids[]** (Array) - Optional - Specify affiliate ID(s) to filter the report.

### Response
#### Success Response (200)
- **data.items** (Array) - A list of affiliate brief reports.
  - **currency** (String) - The currency of the commissions.
  - **aff_id** (String) - The unique ID of the affiliate.
  - **aff_name** (String) - The name of the affiliate.
  - **aff_email** (String) - The email of the affiliate.
  - **total_sales_count** (Number) - The total number of sales generated by the affiliate.
  - **total_commission** (String) - The total commission earned by the affiliate.
  - **pending_commission** (String) - The amount of commission currently pending.
  - **paid_commission** (String) - The amount of commission already paid.
- **data.pagination** (Object) - Pagination details.
  - **total_items** (Number) - Total number of items available.
  - **items_per_page** (String) - Number of items per page.
  - **page_index** (String) - Current page index.
  - **total_pages** (Number) - Total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "currency": "USD",
        "aff_id": "FZHbhb",
        "aff_name": "test 123",
        "aff_email": "test@example.com",
        "total_sales_count": 23,
        "total_commission": "78.01",
        "pending_commission": "78.01",
        "paid_commission": "0.00"
      }
    ],
    "pagination": {
      "total_items": 2,
      "items_per_page": "1",
      "page_index": "1",
      "total_pages": 2
    }
  }
}
```
```

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

### GET /api/v1/live-webinar/get-live-webinars-list

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves a list of upcoming live webinars, including details about their schedule, duration, and registration links.

```APIDOC
## Get Upcoming Live Webinars

### Description
Retrieve scheduled live webinars with registration information
Returns all upcoming live webinars with scheduling details, timezone information, duration, and registration URLs.

### Method
GET

### Endpoint
`/api/v1/live-webinar/get-live-webinars-list`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of webinars to return.
- **page** (integer) - Optional - The page number for pagination.
- **orderby** (string) - Optional - The field to order the results by (e.g., `created_at`).
- **order** (string) - Optional - The order direction (`asc` or `desc`).
- **search** (string) - Optional - A search term to filter webinars by topic.

#### Request Body
None

### Request Example
```bash
curl -X GET 'https://api.newzenler.com/api/v1/live-webinar/get-live-webinars-list?limit=15&page=1&orderby=created_at&order=asc&search=marketing'
```

### Response
#### Success Response (200)
- **data.items** (array) - An array of webinar objects, each containing `id`, `topic`, `schedule_date`, `timezone`, `duration`, `register_url`, `recurring`, and `recent_recurring_schedule`.
- **data.pagination** (object) - Pagination details including `total_items`, `items_per_page`, `page_index`, and `total_pages`.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "id": 1,
        "topic": "Digital Marketing Strategies 2024",
        "schedule_date": "2021-10-09 12:00 PM",
        "timezone": "Asia/Kolkata",
        "duration": 60,
        "register_url": "https://beta.newzenler.com/live-webinar/digital-marketing-strategies-2024/register",
        "recurring": false,
        "recent_recurring_schedule": ""
      }
    ],
    "pagination": {
      "total_items": 2,
      "items_per_page": 15,
      "page_index": 1,
      "total_pages": 1
    }
  }
}
```
```

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

### Enroll User to a Course with cURL

Source: https://www.newzenler.com/api/documentation/public/api-doc

This example shows how to enroll a user into a specific course using their user ID and the course ID. An optional plan ID can also be provided. The response confirms successful enrollment.

```bash
curl https://api.newzenler.com/api/v1/users/{user_id}/enroll -X POST -H 'X-API-Key: my-api-key' -H 'X-Account-Name: my-school' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "course_id": Number,
  "plan_id": Number
}'
```

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

### GET /api/v1/reports/enrollments/brief

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves a summary of enrollment statistics, grouped by course, for a specified date range.

```APIDOC
## Get Brief Enrollment Report

### Description
Retrieve enrollment statistics grouped by course
Returns aggregate enrollment data for courses within a date range. Useful for dashboard metrics and enrollment trend analysis.

### Method
GET

### Endpoint
`/api/v1/reports/enrollments/brief`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **start_date** (string) - Required - The start date for the enrollment report (YYYY-MM-DD).
- **end_date** (string) - Required - The end date for the enrollment report (YYYY-MM-DD).
- **course_ids[]** (array of integers) - Optional - An array of course IDs to filter the report.
- **limit** (integer) - Optional - The maximum number of enrollment records to return per page.
- **page** (integer) - Optional - The page number for pagination.

#### Request Body
None

### Request Example
```bash
curl -X GET 'https://api.newzenler.com/api/v1/reports/enrollments/brief?start_date=2018-01-01&end_date=2018-12-31&course_ids[]=1156&course_ids[]=1150&limit=10&page=1'
```

### Response
#### Success Response (200)
- **data.items** (array) - An array of objects, where each object contains `course_id`, `course_name`, and `no_of_enrollments`.
- **data.pagination** (object) - Pagination details including `total_items`, `items_per_page`, `page_index`, and `total_pages`.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "course_id": 1156,
        "course_name": "Python for Beginners",
        "no_of_enrollments": 247
      }
    ],
    "pagination": {
      "total_items": 3,
      "items_per_page": 10,
      "page_index": 1,
      "total_pages": 1
    }
  }
}
```
```

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

### GET /api/v1/reports/course-progress/brief

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a brief report on course progress for specified courses within a date range.

```APIDOC
## GET /api/v1/reports/course-progress/brief

### Description
Retrieves a brief report on course progress for specified courses within a date range.

### Method
GET

### Endpoint
https://api.newzenler.com/api/v1/reports/course-progress/brief

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **limit** (Number) - Optional - The number of items to be returned. Default: 15
- **page** (Number) - Optional - The page within the collection to fetch. Default: 1
- **course_ids[]** (Array) - Optional - Specify course IDs

### Response
#### Success Response (200)
(Response structure for this endpoint was not fully detailed in the provided text. It is expected to contain course progress data similar to other reports.)

#### Response Example
(Example response not provided in the source text.)
```

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

### GET /api/v1/reports/enrollments/detailed

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a detailed list of enrollments, including user information, for specified courses within a date range.

```APIDOC
## GET /api/v1/reports/enrollments/detailed

### Description
Retrieves a detailed list of enrollments, including user information, for specified courses within a date range.

### Method
GET

### Endpoint
https://api.newzenler.com/api/v1/reports/enrollments/detailed

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **course_id** (String) - Optional - Specify course ID

### Response
#### Success Response (200)
- **response_code** (Number) - Indicates the success of the operation.
- **message** (String) - A message describing the result of the operation.
- **data** (Object)
  - **items** (Array) - A list of enrollment items.
    - **course_id** (Number) - The ID of the course.
    - **user_id** (String) - The ID of the user.
    - **course_name** (String) - The name of the course.
    - **first_name** (String) - The first name of the user.
    - **last_name** (String) - The last name of the user.
    - **email** (String) - The email address of the user.
    - **enrollment_date** (String) - The date and time of enrollment.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "course_id": 1156,
        "user_id": "313.5c0235e95c1dc",
        "course_name": "test",
        "first_name": "Api8",
        "last_name": "api8",
        "email": "api8@example.com",
        "enrollment_date": "2018-12-01 07:24:32"
      }
    ]
  }
}
```
```

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

### Get Courses List

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves a paginated list of all courses with options for searching, filtering by type (course/bundle), and publication status. Includes course thumbnail URLs.

```APIDOC
## GET /api/v1/courses

### Description
Retrieves a paginated list of courses, supporting filtering by type and status, as well as search functionality. Returns course thumbnails.

### Method
GET

### Endpoint
`/api/v1/courses`

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of courses to return per page. Defaults to a system value.
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **orderby** (string) - Optional - The field to order the results by (e.g., `display_order`).
- **order** (string) - Optional - The order of sorting (`asc` or `desc`). Defaults to `asc`.
- **search** (string) - Optional - A search term to filter courses by name or other relevant fields.
- **type** (integer) - Optional - Filters courses by type: `1` for course, `2` for bundle, `0` for all.
- **status** (integer) - Optional - Filters courses by publication status: `1` for published, `0` for unpublished.

#### Request Headers
- **X-API-Key** (string) - Required - Your API key for authentication.
- **X-Account-Name** (string) - Required - The name of your Newzenler account.

### Request Example
```bash
curl -X GET 'https://api.newzenler.com/api/v1/courses?limit=10&page=1&orderby=display_order&order=asc&search=python&type=1&status=1' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **response_code** (integer) - Indicates a successful operation.
- **message** (string) - Confirmation message of the operation.
- **data** (object) - Contains the list of courses and pagination information.
  - **items** (array) - An array of course objects.
    - **id** (integer) - The unique identifier of the course.
    - **name** (string) - The name of the course.
    - **subtitle** (string) - The subtitle of the course.
    - **thumbnail** (string) - URL of the course thumbnail image.
    - **url** (string) - The URL to the course.
  - **pagination** (object) - Pagination details.
    - **total_items** (integer) - The total number of items available.
    - **items_per_page** (integer) - The number of items displayed per page.
    - **page_index** (integer) - The current page number.
    - **total_pages** (integer) - The total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "id": 1159,
        "name": "Python for Beginners",
        "subtitle": "Learn Python from scratch",
        "thumbnail": "https://api.newzenler.com/images/default-course-thumbnail.png",
        "url": "https://api.newzenler.com/courses/python-for-beginners"
      }
    ],
    "pagination": {
      "total_items": 98,
      "items_per_page": 10,
      "page_index": 1,
      "total_pages": 10
    }
  }
}
```
```

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

### GET /api/v1/reports/course-progress/detailed

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a detailed report on course progress, allowing filtering by date, course, and other criteria.

```APIDOC
## GET /api/v1/reports/course-progress/detailed

### Description
Retrieves a detailed report on course progress. This endpoint allows for filtering by date ranges, specific courses, and other advanced options to provide granular insights into student progress.

### Method
GET

### Endpoint
`https://{{account-name}}.newzenler.com/api/v1/reports/course-progress/detailed`

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18).
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18).
- **limit** (Number) - Optional - The number of items to be returned. Default: 15.
- **page** (Number) - Optional - The page within the collection to fetch. Default: 1.
- **course_id[]** (Array) - Optional - Specify course ID(s).
- **af_v** (String) - Optional - Advanced Filter - Specify 1 for advanced filter.
- **coupon_is[]** (Array) - Optional - Filter by coupon.
- **coupon_like[]** (Array) - Optional - Filter by coupon pattern.
- **name_is[]** (Array) - Optional - Filter by student name.
- **name_like[]** (Array) - Optional - Filter by student name pattern.
- **email_is[]** (Array) - Optional - Filter by student email.
- **email_like[]** (Array) - Optional - Filter by student email pattern.
- **affiliate_is[]** (Array) - Optional - Filter by affiliate ID.
- **payment_type** (Number) - Optional - Payment type: 2 (Subscription), 3 (One time payment), or 4 (Payment plan).
- **students_in_course[0][]** (Array) - Optional - Filter students within a course.

### Response
#### Success Response (200)
- **data.items** (Object) - Contains course progress data for each student.
  - **uid** (String) - Unique identifier for the student record.
  - **courseId** (String) - The ID of the course.
  - **name** (String) - The name of the student.
  - **email** (String) - The email of the student.
  - **enrollment_date** (String) - The date and time the student enrolled.
  - **start_date** (String) - The date the student started the course.
  - **completed_date** (String) - The date and time the course was completed.
  - **status** (String) - The current status of the student in the course (e.g., 'In Progress').
  - **last_attended** (String) - The last date and time the student accessed the course.
  - **completion_percentage** (Number) - The percentage of the course completed.
- **data.pagination** (Object) - Pagination details.
  - **total_items** (Number) - Total number of items available.
  - **items_per_page** (String) - Number of items per page.
  - **page_index** (String) - Current page index.
  - **total_pages** (Number) - Total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": {
      "313.5aacb3079ca59": {
        "uid": "313.5aacb3079ca59",
        "courseId": "1036",
        "name": "Test",
        "email": "test@example.com",
        "enrollment_date": "2018-07-10 04:44:49",
        "start_date": "-",
        "completed_date": "-",
        "status": "In Progress",
        "last_attended": "2018-07-10 04:45:03",
        "completion_percentage": 0
      }
    },
    "pagination": {
      "total_items": 2,
      "items_per_page": "1",
      "page_index": "2",
      "total_pages": 2
    }
  }
}
```
```

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

### GET /api/v1/reports/sales/brief

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieve aggregated sales data with grouping options. Returns sales statistics grouped by course, day, or month with revenue breakdowns including affiliate fees and platform earnings.

```APIDOC
## Get Brief Sales Report

### Description
Retrieve aggregated sales data with grouping options

Returns sales statistics grouped by course, day, or month with revenue breakdowns including affiliate fees and platform earnings.

### Method
GET

### Endpoint
`/api/v1/reports/sales/brief`

### Query Parameters
- **start_date** (string) - Required - The start date for the report (YYYY-MM-DD).
- **end_date** (string) - Required - The end date for the report (YYYY-MM-DD).
- **limit** (integer) - Optional - The number of items to return per page.
- **page** (integer) - Optional - The page number to retrieve.
- **groupby** (string) - Required - The field to group the sales data by. Options: `course`, `day`, `month`.
- **course_ids[]** (integer) - Optional - An array of course IDs to filter the report by.

### Request Example
```bash
curl -X GET 'https://api.newzenler.com/api/v1/reports/sales/brief?start_date=2018-01-01&end_date=2018-12-31&limit=20&page=1&groupby=course&course_ids[]=1156' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **total_sales** (integer) - The total number of sales for the period.
- **course_id** (integer) - The ID of the course (if `groupby=course`).
- **earnings_total** (string) - The total earnings in USD.
- **sales_total** (string) - The total sales amount in USD.
- **aff_fee** (string) - The total affiliate fees in USD.
- **name** (string) - The name of the course (if `groupby=course`).
- **day** (string) - The day of the sale (if `groupby=day`).
- **month** (string) - The month of the sale (if `groupby=month`).
- **currency** (string) - The currency of the sales.
- **pagination** (object) - Pagination details for the response.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "total_sales": 47,
        "course_id": 1156,
        "earnings_total": "2847.52",
        "sales_total": "2990.00",
        "aff_fee": "142.48",
        "name": "Python for Beginners",
        "day": "12/15/2018",
        "month": "December-2018",
        "currency": "USD"
      }
    ],
    "pagination": {
      "total_items": 19,
      "items_per_page": 20,
      "page_index": 1,
      "total_pages": 1
    }
  }
}
```
```

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

### Get Course Details

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves detailed information for a specific course, including ownership, visibility, and type. Useful for displaying course pages or synchronizing metadata.

```APIDOC
## GET /api/v1/courses/{course_id}

### Description
Retrieves detailed information for a specific course, including its ownership, visibility settings, and type. This endpoint is useful for displaying course details or syncing metadata.

### Method
GET

### Endpoint
`/api/v1/courses/{course_id}`

### Parameters
#### Path Parameters
- **course_id** (integer) - Required - The unique identifier of the course.

#### Request Headers
- **X-API-Key** (string) - Required - Your API key for authentication.
- **X-Account-Name** (string) - Required - The name of your Newzenler account.

### Request Example
```bash
curl -X GET https://api.newzenler.com/api/v1/courses/1150 \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
- **response_code** (integer) - Indicates a successful operation.
- **message** (string) - Confirmation message of the operation.
- **data** (object) - Contains the details of the course.
  - **items** (object) - Course details.
    - **id** (integer) - The unique identifier of the course.
    - **name** (string) - The name of the course.
    - **subtitle** (string) - The subtitle of the course.
    - **thumbnail** (string) - URL of the course thumbnail.
    - **course_type** (integer) - The type of the course.
    - **owner** (string) - The owner's user ID.
    - **school_id** (integer) - The ID of the school.
    - **public** (integer) - Indicates if the course is public (1) or not (0).
    - **featured** (integer) - Indicates if the course is featured (1) or not (0).
    - **hidden** (integer) - Indicates if the course is hidden (1) or not (0).
    - **private** (integer) - Indicates if the course is private (1) or not (0).

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": {
      "id": 1150,
      "name": "Advanced JavaScript Patterns",
      "subtitle": "Master modern JS design patterns",
      "thumbnail": "https://s3.amazonaws.com/contents.newzenler.com/313/courses/1150/data/thumb/l-4.jpg",
      "course_type": 2,
      "owner": "313.5aacb2806f857",
      "school_id": 313,
      "public": 1,
      "featured": 1,
      "hidden": 0,
      "private": 0
    }
  }
}
```
```

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

### GET /api/v1/reports/sales/brief

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a brief overview of sales data, including total sales and earnings, grouped by specified criteria.

```APIDOC
## GET /api/v1/reports/sales/brief

### Description
Retrieves a brief overview of sales data, including total sales and earnings, grouped by specified criteria.

### Method
GET

### Endpoint
https://api.newzenler.com/api/v1/reports/sales/brief

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **limit** (Number) - Optional - The number of items to be returned. Default: 15
- **page** (Number) - Optional - The page within the collection to fetch. Default: 1
- **groupby** (String) - Optional - It can be 'course', 'day', or 'month'. Default: 'course'
- **course_ids[]** (Array) - Optional - Specify course IDs

### Response
#### Success Response (200)
- **response_code** (Number) - Indicates the success of the operation.
- **message** (String) - A message describing the result of the operation.
- **data** (Object)
  - **items** (Array) - A list of sales items.
    - **total_sales** (Number) - Total number of sales.
    - **course_id** (Number) - The ID of the course.
    - **earnings_total** (String) - Total earnings.
    - **sales_total** (String) - Total sales amount.
    - **aff_fee** (String) - Affiliate fees.
    - **name** (String) - Name associated with the sale (e.g., course name).
    - **day** (String) - The day of the sale.
    - **month** (String) - The month of the sale.
    - **currency** (String) - The currency of the sale.
  - **pagination** (Object) - Pagination details.
    - **total_items** (Number) - Total number of items available.
    - **items_per_page** (Number) - Number of items per page.
    - **page_index** (Number) - The current page index.
    - **total_pages** (Number) - Total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "total_sales": 1,
        "course_id": 1156,
        "earnings_total": "18.52",
        "sales_total": "20.00",
        "aff_fee": "0.00",
        "name": "pppp",
        "day": "12/01/2018",
        "month": "December-2018",
        "currency": "USD"
      }
    ],
    "pagination": {
      "total_items": 19,
      "items_per_page": 1,
      "page_index": 1,
      "total_pages": 19
    }
  }
}
```
```

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

### Authenticate API Calls with cURL

Source: https://www.newzenler.com/api/documentation/public/api-doc

This example demonstrates how to authenticate API calls using cURL by setting the X-API-Key and X-Account-Name headers. Ensure these are replaced with your actual credentials. The Content-Type and Accept headers are set to application/json.

```bash
curl https://api.newzenler.com/api/v1/users -H 'X-API-Key: my-api-key' -H 'X-Account-Name: my-school' -H 'Content-Type: application/json' -H 'Accept: application/json'
```

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

### Get Course Details - Bash API Request

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Fetches detailed information for a specific course using its ID. This includes ownership, visibility settings, and course type. Useful for displaying course pages or syncing metadata.

```bash
curl -X GET https://api.newzenler.com/api/v1/courses/1150 \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### Get Funnels List - Bash

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves a list of marketing funnels with lead tracking statistics. Supports filtering, pagination, and sorting. Requires API key and account name headers.

```bash
curl -X GET 'https://api.newzenler.com/api/v1/funnels?limit=20&page=1&orderby=created_at&order=desc&search=webinar&status=1' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### Get Upcoming Live Webinars - Bash

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves scheduled live webinars with registration information. Returns upcoming webinars with scheduling details, timezone, duration, and registration URLs. Supports filtering and pagination.

```bash
curl -X GET 'https://api.newzenler.com/api/v1/live-webinar/get-live-webinars-list?limit=15&page=1&orderby=created_at&order=asc&search=marketing' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### Get Detailed Course Progress Report using cURL

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Retrieves detailed progress information for individual students across courses. This endpoint provides data on enrollment dates, completion status, last activity, and percentage completed.

```bash
curl -X GET 'https://api.newzenler.com/api/v1/reports/course-progress/detailed?start_date=2018-07-01&end_date=2018-07-31&limit=10&page=2&course_id[]=1036&af_v=1&payment_type=3' \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### Enroll User to Course - Bash API Request

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Enrolls a single user into a specified course. An optional pricing plan ID can be provided for courses with multiple purchase options. This endpoint requires the user ID, course ID, and API credentials.

```bash
curl -X POST https://api.newzenler.com/api/v1/users/313.5bc576509d13d/enroll \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": 1159,
    "plan_id": 42
  }'
```

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

### Get User Details with cURL

Source: https://www.newzenler.com/api/documentation/public/api-doc

This example retrieves the details of a specific user by providing their user ID in the URL. The response includes comprehensive user information such as name, email, address, and roles.

```bash
curl https://api.newzenler.com/api/v1/users/{user_id} -H 'X-API-Key: my-api-key' -H 'X-Account-Name: my-school' -H 'Content-Type: application/json' -H 'Accept: application/json'
```

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

### Enroll User to Course

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Enrolls a single user into a specified course. Allows for optional pricing plan selection for courses with multiple purchase options.

```APIDOC
## POST /api/v1/users/{user_id}/enroll

### Description
Enrolls a specified user into a course. An optional `plan_id` can be provided if the course has multiple pricing options.

### Method
POST

### Endpoint
`/api/v1/users/{user_id}/enroll`

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user to enroll.

#### Request Headers
- **X-API-Key** (string) - Required - Your API key for authentication.
- **X-Account-Name** (string) - Required - The name of your Newzenler account.

#### Request Body
- **course_id** (integer) - Required - The ID of the course to enroll the user in.
- **plan_id** (integer) - Optional - The ID of the pricing plan to use for enrollment.

### Request Example
```bash
curl -X POST https://api.newzenler.com/api/v1/users/313.5bc576509d13d/enroll \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": 1159,
    "plan_id": 42
  }'
```

### Response
#### Success Response (200)
- **response_code** (integer) - Indicates a successful operation.
- **message** (string) - Confirmation message of the operation.
- **data** (string) - Confirmation message regarding user enrollment.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": "User enrolled to the course successfully with plan Premium Monthly"
}
```
```

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

### Get Specific User Details with cURL

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Demonstrates how to retrieve detailed profile information for a specific user in Zenler using cURL. This GET request requires the user's unique ID in the URL.

```bash
curl -X GET https://api.newzenler.com/api/v1/users/313.5bc576509d13d \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json'
```

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

### Register for Live Webinar - Bash

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Registers a user for a live webinar with extended profile information. Requires API Key, Account Name, and user's contact details including name, email, address, and phone number.

```bash
curl -X POST https://api.newzenler.com/api/v1/live-webinar/1/register \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Marcus",
    "email": "marcus.thompson@example.com",
    "last_name": "Thompson",
    "address": "555 Broadway",
    "city": "Seattle",
    "state": "WA",
    "phone": "5554445555",
    "zip_code": "98101"
  }'
```

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

### GET /api/v1/reports/sales/detailed

Source: https://www.newzenler.com/api/documentation/public/api-doc

Retrieves a detailed report of sales transactions, with extensive filtering options.

```APIDOC
## GET /api/v1/reports/sales/detailed

### Description
Retrieves a detailed report of sales transactions, with extensive filtering options.

### Method
GET

### Endpoint
https://api.newzenler.com/api/v1/reports/sales/detailed

### Parameters
#### Query Parameters
- **start_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **end_date** (String) - Optional - Should be in format YYYY-mm-dd (e.g., 2018-05-18)
- **limit** (Number) - Optional - The number of items to be returned. Default: 15
- **page** (Number) - Optional - The page within the collection to fetch. Default: 1
- **course_ids[]** (Array) - Optional - Specify course IDs
- **af_v** (Number) - Optional - Advanced Filter. Specify 1 for advanced filter.
- **coupon_is[]** (String) - Optional - Coupon ID
- **coupon_like[]** (String) - Optional - (Not fully specified in source)
- **name_is[]** (String) - Optional - User ID
- **name_like[]** (String) - Optional - (Not fully specified in source)
- **email_is[]** (String) - Optional - User ID
- **email_like[]** (String) - Optional - (Not fully specified in source)
- **affiliate_is[]** (String) - Optional - Affiliate ID
- **payment_type** (Number) - Optional - Payment type: 2 (Subscription), 3 (One-time payment), or 4 (Payment plan).

### Request Example
```
https://api.newzenler.com/api/v1/reports/sales/detailed?start_date=&end_date=&limit=&page=&course_ids[]=&af_v=1&coupon_is[0][]=coupon_id&coupon_like[]&name_is[0][]=user_id&name_like[]&email_is[0][]=user_id&email_like[]&affiliate_is[]&payment_type
```

### Response
#### Success Response (200)
- **response_code** (Number) - Indicates the success of the operation.
- **message** (String) - A message describing the result of the operation.
- **data** (Object)
  - **items** (Array) - A list of sales transaction items.
    - **created_at** (String) - The date and time of the transaction.
    - **transaction_id** (String) - The unique ID of the transaction.
    - **sales_price** (String) - The sales price of the transaction.
    - **earn_price** (String) - The earnings from the transaction.
    - **student_name** (String) - The name of the student.
    - **student_email** (String) - The email of the student.
    - **course** (String) - The name of the course.
    - **course_id** (Number) - The ID of the course.
    - **coupon_code** (String/null) - The coupon code used, if any.
    - **payment_gateway** (String) - The payment gateway used.
  - **pagination** (Object) - Pagination details.
    - **total_items** (Number) - Total number of items available.
    - **items_per_page** (Number) - Number of items per page.
    - **page_index** (Number) - The current page index.
    - **total_pages** (Number) - Total number of pages.

#### Response Example
```json
{
  "response_code": 200,
  "message": "success",
  "data": {
    "items": [
      {
        "created_at": "12/01/2018",
        "transaction_id": "ch_1DcQOlAtpWV408k9dAlNnzN3",
        "sales_price": "$20.00",
        "earn_price": "$18.52",
        "student_name": "test 2",
        "student_email": "test2@test.com",
        "course": "pppp",
        "course_id": 1156,
        "coupon_code": null,
        "payment_gateway": "Stripe"
      }
    ],
    "pagination": {
      "total_items": 1,
      "items_per_page": 1,
      "page_index": 1,
      "total_pages": 1
    }
  }
}
```
```

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

### Register for Live Class - Bash

Source: https://context7.com/context7/newzenler_api_public/llms.txt

Registers a user for a specific upcoming live class. This grants them access to the session and adds them to reminder lists. Requires live class ID, user's name, email, last name, API key, and account name.

```bash
curl -X POST https://api.newzenler.com/api/v1/live-class/4/register \
  -H 'X-API-Key: your-api-key-here' \
  -H 'X-Account-Name: your-school' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Emily",
    "email": "emily.chen@example.com",
    "last_name": "Chen"
  }'
```
Tokens:
Raw