Serviceform

https://help.serviceform.com/
Admin
Serviceform is a no-code platform for creating and deploying conversion tools including chatbots,...
Tokens:33,615
Snippets:727
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Leads Response Example

Source: https://help.serviceform.com/articles/public-api

This is an example of a successful response when retrieving leads. It outlines the structure and fields returned for each lead object.

```json
{
  "id": "string",
  "page_url": "string",
  "pid": "string",
  "language": "string",
  "source": "string",
  "tools": [{ "tid": "string" }],
  "tid": "string",
  "sid": "string",
  "duration": 0,
  "uid": "string",
  "pageviews": 0,
  "pages": [{ "duration": 0, "referrer": "string", "website": "string" }],
  "browser": "string",
  "tokens": [{}],
  "first_name": "string",
  "email": "string",
  "timestamp": "2024-08-30T05:48:46.202Z",
  "tool_name": "string",
  "os": "string",
  "indexed": true,
  "created": "2024-08-30T05:48:46.202Z",
  "mobile": true,
  "last_name": "string",
  "history": [
    { "id": "string", "message": "string", "type": "string", "timestamp": 0 }
  ],
  "referrer": "string",
  "site": "string",
  "phone": "string",
  "name": "string",
  "page": "string",
  "referrer_url": "string",
  "updated": "2024-08-30T05:48:46.202Z",
  "space_id": "string"
}
```

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

### Get All Chats Example Response

Source: https://help.serviceform.com/articles/public-api

This is an example of a successful response when retrieving chat history. It includes details about each chat session, agent information, and message content if requested.

```json
[
  {
    "cid": "chat123",
    "agentEmail": "agent@example.com",
    "agentId": "agent123",
    "agentName": "John Doe",
    "agentJoinedTime": 1672531200,
    "avgBetweenMsg": 30,
    "business_phone": "+1234567890",
    "phone": "+1234567890",
    "first_name": "Jane",
    "last_name": "Doe",
    "name": "Jane Doe",
    "fullUrl": "https://example.com/chat",
    "lastLiveMsg": 1672531300,
    "changed": 1672531400,
    "lastMessage": "Thank you for your inquiry!",
    "lastMessageTime": 1672531350,
    "lastSender": "agent",
    "leadSentTo": "sales@example.com",
    "livechat": 1,
    "livechatStarted": 1672531200,
    "msgType": "text",
    "regNo": "ABC123",
    "session": "session123",
    "sid": "site123",
    "sitename": "Example Site",
    "source": "website",
    "team": "Support",
    "uid": "user123",
    "url": "/support/chat",
    "history": [
      {
        "id": "msg1",
        "message": "Hello, how can I help you?",
        "type": "text",
        "timestamp": 1672531250
      },
      {
        "id": "msg2",
        "message": "I have a question about your service.",
        "type": "text",
        "timestamp": 1672531280
      }
    ]
  }
]
```

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

### GET /leads

Source: https://help.serviceform.com/articles/public-api

Retrieves a list of leads from the system.

```APIDOC
## GET /leads

### Description
Retrieves a list of leads.

### Method
GET

### Endpoint
/leads

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **page_url** (string) - URL of the page
- **pid** (string) - Project ID
- **language** (string) - Language code
- **source** (string) - Source of the lead
- **tools** (array) - List of tools used
- **tid** (string) - Tool ID
- **sid** (string) - Session ID
- **duration** (number) - Duration
- **uid** (string) - User ID
- **pageviews** (number) - Number of pageviews
- **pages** (array) - List of pages visited
- **browser** (string) - Browser information
- **tokens** (array) - Tokens
- **first_name** (string) - First name
- **email** (string) - Email address
- **timestamp** (string) - Timestamp
- **tool_name** (string) - Name of the tool
- **os** (string) - Operating system
- **indexed** (boolean) - Indexed status
- **created** (string) - Creation timestamp
- **mobile** (boolean) - Mobile device status
- **last_name** (string) - Last name
- **history** (array) - Interaction history
- **referrer** (string) - Referrer
- **site** (string) - Site name
- **phone** (string) - Phone number
- **name** (string) - Full name
- **page** (string) - Page name
- **referrer_url** (string) - Referrer URL
- **updated** (string) - Last updated timestamp
- **space_id** (string) - Space ID

#### Response Example
{
  "id": "string",
  "page_url": "string",
  "pid": "string",
  "language": "string",
  "source": "string",
  "tools": [{ "tid": "string" }],
  "tid": "string",
  "sid": "string",
  "duration": 0,
  "uid": "string",
  "pageviews": 0,
  "pages": [{ "duration": 0, "referrer": "string", "website": "string" }],
  "browser": "string",
  "tokens": [{}],
  "first_name": "string",
  "email": "string",
  "timestamp": "2024-08-30T05:48:46.202Z",
  "tool_name": "string",
  "os": "string",
  "indexed": true,
  "created": "2024-08-30T05:48:46.202Z",
  "mobile": true,
  "last_name": "string",
  "history": [
    { "id": "string", "message": "string", "type": "string", "timestamp": 0 }
  ],
  "referrer": "string",
  "site": "string",
  "phone": "string",
  "name": "string",
  "page": "string",
  "referrer_url": "string",
  "updated": "2024-08-30T05:48:46.202Z",
  "space_id": "string"
}
```

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

### Get Chat Statistics Example Response

Source: https://help.serviceform.com/articles/public-api

This JSON object represents the successful retrieval of chat statistics. It includes aggregated data such as total chats, average response times, satisfaction scores, and breakdowns by agent and source.

```json
{
	"totalChats": 150,
  "averageResponseTime": 45, // in seconds
  "satisfactionScore": 4.5, // out of 5
  "chatsByAgent": [
    {
      "agentId": "agent123",
      "agentName": "John Doe",
      "totalChats": 50,
      "averageResponseTime": 30
    },
    {
      "agentId": "agent124",
      "agentName": "Jane Smith",
      "totalChats": 100,
      "averageResponseTime": 50
    }
  ],
  "chatsBySource": { "website": 120, "mobile": 30 },
  "chatDurations": { "0-5 minutes": 60, "5-10 minutes": 40, "10+ minutes": 50 }
}
```

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

### GET /flex/spaces

Source: https://help.serviceform.com/articles/public-api

Retrieve a list of all available spaces.

```APIDOC
## GET /flex/spaces

### Description
Retrieve a list of all spaces.

### Method
GET

### Endpoint
/flex/spaces

### Response
#### Success Response (200)
- **id** (string) - Space ID
- **name** (string) - Space name
- **fields** (array) - List of fields associated with the space

#### Response Example
{
  "id": "string",
  "name": "string",
  "fields": [
    {
      "machine": "string",
      "name": "string",
      "id": "string",
      "type": "string",
      "options": [
        {
          "machine": "string",
          "label": "string",
          "value": "string"
        }
      ]
    }
  ]
}
```

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

### GET /flex/spaces/{spaceId}/items

Source: https://help.serviceform.com/articles/public-api

Retrieve all items belonging to a specific space.

```APIDOC
## GET /flex/spaces/{spaceId}/items

### Description
Retrieve items for a specific space identified by {spaceId}.

### Method
GET

### Endpoint
/flex/spaces/{spaceId}/items

### Parameters
#### Path Parameters
- **spaceId** (string) - Required - ID of the space.

### Response
#### Success Response (200)
- **items** (array) - List of items in the space

#### Response Example
[{
  "last_updater": "string",
  "uid": "string",
  "clientId": "string",
  "created": "2024-08-30T05:48:46.195Z",
  "id": "string",
  "updated": "2024-08-30T05:48:46.195Z",
  "uuid": "string",
  "space_id": "string",
  "primary_field": "string"
}]
```

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

### GET /flex/spaces/{spaceId}/items/{itemId}

Source: https://help.serviceform.com/articles/public-api

Retrieve details of a specific item within a space.

```APIDOC
## GET /flex/spaces/{spaceId}/items/{itemId}

### Description
Retrieve a specific item from a space using {spaceId} and {itemId}.

### Method
GET

### Endpoint
/flex/spaces/{spaceId}/items/{itemId}

### Parameters
#### Path Parameters
- **spaceId** (string) - Required - ID of the space.
- **itemId** (string) - Required - ID of the item.

### Response
#### Success Response (200)
- **item** (object) - The requested item details

#### Response Example
{
  "last_updater": "string",
  "uid": "string",
  "clientId": "string",
  "created": "2024-08-30T05:48:46.199Z",
  "id": "string",
  "updated": "2024-08-30T05:48:46.199Z",
  "uuid": "string",
  "space_id": "string",
  "primary_field": "string"
}
```

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

### POST /flex/spaces/{spaceId}/items

Source: https://help.serviceform.com/articles/public-api

Create a new item within a specified space.

```APIDOC
## POST /flex/spaces/{spaceId}/items

### Description
Create a new item within a specified space.

### Method
POST

### Endpoint
/flex/spaces/{spaceId}/items

### Parameters
#### Path Parameters
- **spaceId** (string) - Required - ID of the space.

#### Request Body
- **primary_field** (string) - Required - The primary field value for the new item.

### Request Example
{
  "primary_field": "string"
}
```

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

### PUT /flex/spaces/{spaceId}/items/{itemId}

Source: https://help.serviceform.com/articles/public-api

Update an existing item within a specific space.

```APIDOC
## PUT /flex/spaces/{spaceId}/items/{itemId}

### Description
Update an item within a specific space.

### Method
PUT

### Endpoint
/flex/spaces/{spaceId}/items/{itemId}

### Parameters
#### Path Parameters
- **spaceId** (string) - Required - ID of the space.
- **itemId** (string) - Required - ID of the item.

#### Request Body
- **primary_field** (string) - Required - The updated primary field value.

### Request Example
{
  "primary_field": "string"
}
```

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

### GET /statistics/chat

Source: https://help.serviceform.com/articles/public-api

Retrieves chat-related statistics, including key performance indicators and aggregated data about chats.

```APIDOC
## GET /statistics/chat

### Description
Retrieves chat-related statistics, including key performance indicators and aggregated data about chats.

### Method
GET

### Endpoint
/statistics/chat

### Parameters
#### Query Parameters
- **startTime** (string) - Optional - Start of the time range in ISO 8601 format.
- **endTime** (string) - Optional - End of the time range in ISO 8601 format.
- **metrics** (array) - Optional - List of specific metrics to retrieve.

### Response
#### Success Response (200)
- **Object** (object) - Successfully retrieved chat statistics.

#### Response Example
{
	"totalChats": 150,
  "averageResponseTime": 45,
  "satisfactionScore": 4.5,
  "chatsByAgent": [
    {
      "agentId": "agent123",
      "agentName": "John Doe",
      "totalChats": 50,
      "averageResponseTime": 30
    },
    {
      "agentId": "agent124",
      "agentName": "Jane Smith",
      "totalChats": 100,
      "averageResponseTime": 50
    }
  ],
  "chatsBySource": { "website": 120, "mobile": 30 },
  "chatDurations": { "0-5 minutes": 60, "5-10 minutes": 40, "10+ minutes": 50 }
}
```

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

### Get All Chats Request Body

Source: https://help.serviceform.com/articles/public-api

Use this JSON payload to filter and retrieve chat history. Specify time ranges, user IDs, and other criteria to narrow down results. Ensure the sf-api-key header is included for authentication.

```json
{
  "startTime": "2024-08-30T05:48:46.204Z",
  "endTime": "2024-08-30T05:48:46.204Z",
  "uid": "user123",
  "limit": 10,
  "showMessages": true,
  "chatbot": true
}
```
Tokens:
Raw