Upfluence

https://docs.upfluence.co/docs
Admin
Upfluence is an influencer marketing platform that provides REST APIs to search and analyze...
Tokens:12,183
Snippets:127
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /orders

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

List all orders linked to a campaign through discount codes.

```APIDOC
## GET /orders

### Description
List all orders linked to a campaign through discount codes. Returns orders that have matched any generated discount code, along with associated discount codes and influencer information.

### Method
GET

### Endpoint
https://publishr.upfluence.co/private/api/v1/orders

### Parameters
#### Query Parameters
- **campaign_id** (string) - Optional - Filter orders by campaign ID.
- **order_date[]** (string) - Optional - Filter orders by date range using Unix timestamps (e.g., [{"key":"lower_bound","value":1640000000},{"key":"upper_bound","value":1672536000}]).
- **page** (integer) - Optional - Page number for pagination.
- **per_page** (integer) - Optional - Number of results per page.
```

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

### Example API Response

Source: https://docs.upfluence.co/docs/introduction

Successful requests return a JSON object containing the requested resource details.

```json
{
  "id": "12345",
  "type": "influencer",
  "name": "Jane Doe",
  "platforms": ["instagram", "youtube"],
  "country": "FR"
}
```

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

### GET https://api.upfluence.co/v1/lists/{id}

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Fetches detailed information about a specific list.

```APIDOC
## GET https://api.upfluence.co/v1/lists/{id}

### Description
Returns a specific list belonging to the user.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/lists/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the list
```

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

### GET /campaigns

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Retrieve a list of all campaigns with pagination and optional search filtering.

```APIDOC
## GET /campaigns

### Description
Retrieve a list of all your campaigns with pagination support to view campaign names, statuses, and contribution counts.

### Method
GET

### Endpoint
https://publishr.upfluence.co/private/api/v1/campaigns

### Parameters
#### Query Parameters
- **s** (string) - Optional - Filter campaigns by name.
```

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

### API Response Headers for Usage Monitoring

Source: https://docs.upfluence.co/docs/errors

Example of HTTP response headers indicating credit limits and consumption.

```http
HTTP/1.1 200 OK
Content-Type: application/json
X-Endpoint-Limit: 10000
X-Endpoint-Spent: 12
...
```

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

### GET /campaigns/{id}

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Fetch detailed information about a specific campaign, including contribution statistics.

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

### Description
Fetch your campaign information including contribution statistics showing how many influencers have applied, been approved, and are in various stages of the workflow.

### Method
GET

### Endpoint
https://publishr.upfluence.co/private/api/v1/campaigns/{id}

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

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

### GET https://analytics.upfluence.co/api/v1/streams/{id}

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve the full configuration of a specific stream, including filters and settings.

```APIDOC
## GET https://analytics.upfluence.co/api/v1/streams/{id}

### Description
Retrieve the full definition and configuration of a specific stream, including followed influencers, keyword filters, and settings.

### Method
GET

### Endpoint
https://analytics.upfluence.co/api/v1/streams/{id}

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

### Request Example
curl -X GET "https://analytics.upfluence.co/api/v1/streams/{stream_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get List Details

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Fetches detailed information about a specific list, including influencer status counts.

```curl
curl -X GET "https://api.upfluence.co/v1/lists/{list_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### GET /contributions

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Retrieve influencer contributions filtered by campaign or influencer.

```APIDOC
## GET /contributions

### Description
Retrieve contributions filtered by campaign or influencer. Each contribution represents an influencer's participation in a campaign.

### Method
GET

### Endpoint
https://publishr.upfluence.co/private/api/v1/contributions

### Parameters
#### Query Parameters
- **campaign_id** (string) - Optional - Filter contributions by campaign ID.
- **influencer_id** (string) - Optional - Filter contributions by influencer ID.

*Note: At least one of campaign_id or influencer_id must be provided.*
```

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

### GET https://analytics.upfluence.co/api/v1/matches

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve social media posts that match campaign stream criteria.

```APIDOC
## GET https://analytics.upfluence.co/api/v1/matches

### Description
Retrieve posts that matched stream filters along with complete social media profile data and engagement metrics.

### Method
GET

### Endpoint
https://analytics.upfluence.co/api/v1/matches

### Parameters
#### Query Parameters
- **stream_id** (string) - Required - The ID of the stream to fetch matches for.
- **page** (integer) - Optional - Page number for pagination.
- **per_page** (integer) - Optional - Number of results per page.
- **ordering_key** (string) - Optional - Field to order results by (e.g., timestamp).
- **ordering_direction** (string) - Optional - Direction of ordering (e.g., desc).

### Request Example
curl -X GET "https://analytics.upfluence.co/api/v1/matches?stream_id={stream_id}&page=1&per_page=50&ordering_key=timestamp&ordering_direction=desc" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### GET https://api.upfluence.co/v1/list_entries

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Retrieves all influencers in a specific list with pagination support.

```APIDOC
## GET https://api.upfluence.co/v1/list_entries

### Description
Returns all list entries for a specific list with influencer details.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/list_entries

### Query Parameters
- **list_id** (integer) - Required - The ID of the list to retrieve
- **page** (integer) - Optional - The page number for pagination
- **per_page** (integer) - Optional - The number of results per page
```

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

### API Rate Limit Error Response

Source: https://docs.upfluence.co/docs/errors

Example of the JSON error body returned when the monthly credit limit is exceeded.

```http
HTTP/1.1 402 Payment Required
Content-Type: application/json

{
  "error": "Limit exceeded"
}
```

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

### GET https://publishr.upfluence.co/private/api/v1/campaigns/{id}

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve detailed information about a specific campaign, including the stream_id required for content monitoring.

```APIDOC
## GET https://publishr.upfluence.co/private/api/v1/campaigns/{id}

### Description
Retrieve detailed information about a specific campaign, including the total number of influencers contacted. The response includes a `stream_id` field used to link the campaign to its content monitoring stream.

### Method
GET

### Endpoint
https://publishr.upfluence.co/private/api/v1/campaigns/{id}

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

### Request Example
curl -X GET "https://publishr.upfluence.co/private/api/v1/campaigns/{campaign_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### GET https://analytics.upfluence.co/api/v1/streams/{id}/stats

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve comprehensive engagement metrics and analytics for a stream.

```APIDOC
## GET https://analytics.upfluence.co/api/v1/streams/{id}/stats

### Description
Retrieve comprehensive statistics for a stream, including engagement metrics, reach, impressions, and EMV by post type.

### Method
GET

### Endpoint
https://analytics.upfluence.co/api/v1/streams/{id}/stats

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

#### Query Parameters
- **from** (integer) - Optional - Start timestamp for the statistics period.
- **to** (integer) - Optional - End timestamp for the statistics period.

### Request Example
curl -X GET "https://analytics.upfluence.co/api/v1/streams/{stream_id}/stats?from=1750802400&to=1755813608" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### GET /v1/influencers/{id}/attributes

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Fetch custom attributes for an influencer.

```APIDOC
## GET /v1/influencers/{id}/attributes

### Description
Fetch custom attributes for an influencer, such as contact details, ratings, and shipping information.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/attributes

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

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

### GET /v1/influencers/{id}/tags

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Fetch all tags currently assigned to an influencer.

```APIDOC
## GET /v1/influencers/{id}/tags

### Description
Get all tags assigned to an influencer.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/tags

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

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

### GET /v1/influencers/{id}/merge_fields

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Fetch merge fields assigned to an influencer.

```APIDOC
## GET /v1/influencers/{id}/merge_fields

### Description
Fetch merge fields assigned to an influencer. Each merge field includes a slug, name, and value.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/merge_fields

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

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

### GET /v1/media/mentions

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Retrieves brand mention insights for a specific social media account to identify existing partnerships or competitor conflicts.

```APIDOC
## GET /v1/media/mentions

### Description
Provides insights about the brand mentions of a social media account. Currently, only the media_type instagram and tiktok is handled.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/media/mentions

### Parameters
#### Query Parameters
- **media_type** (string) - Required - The platform type (e.g., instagram, tiktok)
- **media_id** (string) - Required - The platform-specific ID from the influencer profile
- **limit** (integer) - Optional - The number of results to return

### Request Example
curl -X GET "https://api.upfluence.co/v1/media/mentions?media_type=instagram&media_id={instagram_id}&limit=5" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### GET https://api.upfluence.co/v1/influencers/{id}

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Retrieve comprehensive profile data for a specific influencer, including personal information, social media accounts, and content across all platforms.

```APIDOC
## GET https://api.upfluence.co/v1/influencers/{id}

### Description
Retrieve comprehensive profile data for a specific influencer, including personal information, social media accounts, and content across all platforms.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/influencers/{id}

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

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

### GET https://api.upfluence.co/v1/audience

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Retrieve comprehensive audience demographics and characteristics for a specific influencer, including age, gender, geographic location, and authenticity metrics.

```APIDOC
## GET https://api.upfluence.co/v1/audience

### Description
Retrieve comprehensive audience demographics and characteristics for a specific influencer, including age, gender, geographic location, and authenticity metrics.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/audience

### Parameters
#### Query Parameters
- **influencer_id** (string) - Required - The unique identifier of the influencer
```

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

### GET https://api.upfluence.co/v1/instagram_medias

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Returns Instagram medias related to an instagram_id. This endpoint returns polymorphic content representing any type of post in the Instagram user feed.

```APIDOC
## GET https://api.upfluence.co/v1/instagram_medias

### Description
Returns Instagram medias related to an instagram_id. This endpoint returns polymorphic content representing any type of post in the Instagram user feed.

### Method
GET

### Endpoint
https://api.upfluence.co/v1/instagram_medias

### Parameters
#### Query Parameters
- **instagram_id** (string) - Required - The Instagram identifier of the influencer
- **limit** (integer) - Optional - Number of media items to return
```

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

### Create a Brand Monitoring Stream

Source: https://docs.upfluence.co/docs/examples/brand-social-listening

Initializes a new stream with keyword filters across multiple platforms to track brand mentions.

```curl
curl -X POST "https://analytics.upfluence.co/api/v1/streams" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stream": {
      "name": "YourBrand Social Listening",
      "post_types": ["instagram_media", "tweet", "tiktok_video", "youtube_video"],
      "keyword_filters": [
        {
          "keywords": ["YourBrand"],
          "field_type": "content",
          "post_type": "instagram_media",
          "condition": "include"
        },
        {
          "keywords": ["YourBrand"],
          "field_type": "content",
          "post_type": "tweet",
          "condition": "include"
        },
        {
          "keywords": ["YourBrand"],
          "field_type": "content",
          "post_type": "tiktok_video",
          "condition": "include"
        },
        {
          "keywords": ["YourBrand"],
          "field_type": "content",
          "post_type": "youtube_video",
          "condition": "include"
        }
      ]
    },
    "auto_start": true
  }'
```

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

### Manage Pricing and Rate Cards

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Store influencer pricing and negotiation notes using merge fields.

```bash
curl -X POST "https://api.upfluence.co/v1/influencers/{influencer_id}/merge_fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upsert_merge_fields": [
      {
        "slug": "instagram_story_rate",
        "name": "Instagram Story Rate",
        "value": "$200"
      },
      {
        "slug": "instagram_post_rate",
        "name": "Instagram Post Rate",
        "value": "$350"
      },
      {
        "slug": "youtube_integration_rate",
        "name": "YouTube Integration Rate",
        "value": "$800"
      },
      {
        "slug": "negotiation_notes",
        "name": "Negotiation Notes",
        "value": "Willing to bundle packages at 10% discount"
      }
    ]
  }'
```

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

### API Versioning

Source: https://docs.upfluence.co/docs/introduction

The current stable API version is v1, specified in the URL path.

```text
https://api.upfluence.co/v1/
```

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

### Rate Limits and Usage Monitoring

Source: https://docs.upfluence.co/docs/errors

Information on rate limits for specific endpoints and how to track credit consumption using response headers.

```APIDOC
## Rate Limits

### Affected Endpoints
- `POST /v1/matches`
- `GET /v1/influencers/{id}`

### Monitoring Headers
- `X-Endpoint-Limit`: Your total monthly credit limit.
- `X-Endpoint-Spent`: Credits consumed in the last 30 days.

### Example Response Header
```
HTTP/1.1 200 OK
Content-Type: application/json
X-Endpoint-Limit: 10000
X-Endpoint-Spent: 12
```

### Error Response (402)
```
HTTP/1.1 402 Payment Required
Content-Type: application/json

{
  "error": "Limit exceeded"
}
```
```

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

### Fetch All Campaigns

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Retrieve a list of all campaigns with pagination and optional name filtering.

```http
GET
https://publishr.upfluence.co/private/api/v1/campaigns
```

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

### POST /token

Source: https://docs.upfluence.co/docs/authentication

Authenticate using client credentials or a refresh token to obtain an access token.

```APIDOC
## POST https://identity.upfluence.co/token

### Description
Authenticate using your Upfluence client credentials to obtain an access token or use a refresh token to obtain a new one.

### Method
POST

### Endpoint
https://identity.upfluence.co/token

### Parameters
#### Request Body
- **grant_type** (string) - Required - The grant type, either 'client_credentials' or 'refresh_token'.
- **token_lifetime** (integer) - Optional - Configurable lifetime for the token up to 30 days.
```

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

### Fetch Campaign Details via cURL

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve campaign information to obtain the stream_id required for content monitoring.

```bash
curl -X GET "https://publishr.upfluence.co/private/api/v1/campaigns/{campaign_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Authenticate API Requests

Source: https://docs.upfluence.co/docs/introduction

Use the Authorization header with a Bearer token to authenticate requests to the API.

```bash
curl -H "Authorization: Bearer <ACCESS_TOKEN>" \
  https://api.upfluence.co/v1/influencers/123
```

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

### POST https://api.upfluence.co/v1/lists

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Creates a new list for the user to organize influencers.

```APIDOC
## POST https://api.upfluence.co/v1/lists

### Description
Creates a new list for the user.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/lists

### Request Body
- **list** (object) - Required - Contains the list details
  - **name** (string) - Required - The name of the list

### Request Example
{
  "list": {
    "name": "Summer Fashion Campaign 2024"
  }
}
```

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

### Fetch Stream Information via cURL

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve the configuration and settings for a specific stream using its stream_id.

```bash
curl -X GET "https://analytics.upfluence.co/api/v1/streams/{stream_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Authenticate via URL Query Parameter

Source: https://docs.upfluence.co/docs/authentication

Alternative method for passing tokens, though not recommended due to security risks associated with server logs and browser history.

```curl
curl "https://api.upfluence.co/v1/influencers/42?access_token=<ACCESS_TOKEN>"
```

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

### View All List Entries

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Retrieves all influencers in a list with pagination support.

```curl
curl -X GET "https://api.upfluence.co/v1/list_entries?list_id={list_id}&page=1&per_page=50" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Manage Influencer Attributes

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Use upsert_fields to add or update attributes and discard_fields to remove them. Requires a valid access token.

```bash
curl -X POST "https://api.upfluence.co/v1/influencers/{influencer_id}/attributes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upsert_fields": [
      {
        "key": "first_name",
        "value": "Sarah"
      },
      {
        "key": "email",
        "value": "sarah.influencer@example.com"
      },
      {
        "key": "rating",
        "value": 5
      },
      {
        "key": "phone_number",
        "value": "+33102030405"
      }
    ],
    "discard_fields": ["last_name"]
  }'
```

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

### Create a New Influencer List

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Creates a new list for organizing influencers by campaign or niche.

```curl
curl -X POST "https://api.upfluence.co/v1/lists" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list": {
      "name": "Summer Fashion Campaign 2024"
    }
  }'
```

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

### Bulk Tag Influencers

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Apply consistent tags to multiple influencers by iterating through IDs in a loop.

```bash
# Tag multiple influencers as part of a campaign
for influencer_id in 42 43 44 45; do
  curl -X POST "https://api.upfluence.co/v1/influencers/$influencer_id/tags" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "upsert_tags": ["summer-campaign-2024", "tier-1"]
    }'
done
```

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

### Filter Orders by Date Range

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Track orders within specific time periods using Unix timestamps for lower and upper bounds.

```bash
curl -X GET "https://publishr.upfluence.co/private/api/v1/orders?campaign_id={campaign_id}&order_date[]=%5B%7B%22key%22%3A%22lower_bound%22%2C%22value%22%3A1640000000%7D%2C%7B%22key%22%3A%22upper_bound%22%2C%22value%22%3A1672536000%7D%5D&page=1&per_page=50" \
-H "Authorization: Bearer YOUR_API_KEY"
```

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

### Update Contact and Shipping Information

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Update comprehensive contact details for an influencer profile.

```bash
curl -X POST "https://api.upfluence.co/v1/influencers/{influencer_id}/attributes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upsert_fields": [
      {
        "key": "email",
        "value": "collaborations@influencer.com"
      },
      {
        "key": "first_name",
        "value": "Alex"
      },
      {
        "key": "last_name",
        "value": "Johnson"
      },
      {
        "key": "phone_number",
        "value": "+14155551234"
      },
      {
        "key": "rating",
        "value": 5
      }
    ]
  }'
```

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

### List Campaign Orders

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

List e-commerce orders linked to a campaign via discount codes.

```http
GET
https://publishr.upfluence.co/private/api/v1/orders
```

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

### Retrieve Campaign Details

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Fetch detailed information and contribution statistics for a specific campaign by ID.

```http
GET
https://publishr.upfluence.co/private/api/v1/campaigns/{id}
```

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

### POST https://api.upfluence.co/v1/matches

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Search for influencers according to a set of criteria, filters, ordering preferences, and audience characteristics.

```APIDOC
## POST https://api.upfluence.co/v1/matches

### Description
Search for influencers according to a set of criteria, filters, ordering preferences, and audience characteristics. This endpoint combines multiple search components to provide precise targeting capabilities.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/matches

### Request Body
- **page** (integer) - Optional - Page number for pagination
- **per_page** (integer) - Optional - Number of results per page
- **social_media_matching_operator** (string) - Optional - Operator for matching (e.g., "or")
- **criterias** (array) - Optional - List of search criteria
- **filters** (array) - Optional - List of influencer filters
- **audience_filters** (array) - Optional - List of audience demographic filters
- **ordering** (object) - Optional - Sorting configuration

### Request Example
{
  "page": 1,
  "per_page": 20,
  "social_media_matching_operator": "or",
  "criterias": [
    { "type": "should", "field": "all", "value": "fashion beauty" }
  ],
  "filters": [
    { "type": "multi-string", "field": "influencer.geo_country", "value": ["US"] }
  ],
  "ordering": { "value": "relevancy", "direction": "desc" }
}
```

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

### POST https://analytics.upfluence.co/api/v1/followings

Source: https://docs.upfluence.co/docs/examples/brand-social-listening

Add specific influencers to a stream to monitor their content regardless of keyword mentions.

```APIDOC
## POST https://analytics.upfluence.co/api/v1/followings

### Description
Add influencers to follow in a stream. The stream will monitor posts from these influencers based on the configured filters.

### Method
POST

### Endpoint
https://analytics.upfluence.co/api/v1/followings

### Request Body
- **stream_id** (string) - Required - The ID of the stream
- **followings** (array) - Required - List of influencer objects to follow

### Request Example
{
  "stream_id": "{stream_id}",
  "followings": [
    { "influencer_id": "{influencer_id_1}" }
  ]
}
```

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

### Manage Influencer Tags

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Add or remove tags for an influencer atomically. Tags must be non-empty strings.

```bash
curl -X POST "https://api.upfluence.co/v1/influencers/{influencer_id}/tags" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upsert_tags": ["fashion", "lifestyle", "vip-tier"],
    "delete_tags": ["pending-review"]
  }'
```

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

### Fetch Stream Statistics via cURL

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Retrieve engagement metrics and analytics for a stream, optionally filtered by a date range.

```bash
curl -X GET "https://analytics.upfluence.co/api/v1/streams/{stream_id}/stats?from=1750802400&to=1755813608" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Authenticate via Authorization Header

Source: https://docs.upfluence.co/docs/authentication

Recommended method for including the access token in API requests to prevent token leakage in logs.

```curl
curl -H "Authorization: Bearer <ACCESS_TOKEN>" \
  https://api.upfluence.co/v1/influencers/42
```

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

### PUT https://api.upfluence.co/v1/lists/{id}

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Updates an existing list's information.

```APIDOC
## PUT https://api.upfluence.co/v1/lists/{id}

### Description
Updates an existing list.

### Method
PUT

### Endpoint
https://api.upfluence.co/v1/lists/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the list

### Request Body
- **list** (object) - Required - Contains the updated list details
  - **name** (string) - Optional - The new name of the list

### Request Example
{
  "list": {
    "name": "Summer Fashion Campaign 2024 - Final Selection"
  }
}
```

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

### POST https://api.upfluence.co/v1/list_entries

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Adds an influencer to a specific list.

```APIDOC
## POST https://api.upfluence.co/v1/list_entries

### Description
Adds an influencer to a list.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/list_entries

### Request Body
- **list_entry** (object) - Required - Contains the entry details
  - **list_id** (integer) - Required - The ID of the list
  - **influencer_id** (integer) - Required - The ID of the influencer

### Request Example
{
  "list_entry": {
    "list_id": 153395,
    "influencer_id": 12986860
  }
}
```

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

### POST /v1/matches

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Performs advanced searches for influencers based on multi-platform criteria, follower counts, contact availability, and engagement growth metrics.

```APIDOC
## POST /v1/matches

### Description
Finds influencers matching specific criteria across multiple platforms, including follower ranges, email availability, and engagement growth rates.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/matches

### Request Body
- **page** (integer) - Required - Page number for pagination
- **per_page** (integer) - Required - Number of results per page
- **social_media_matching_operator** (string) - Optional - Logical operator for matching (e.g., "and")
- **criterias** (array) - Optional - List of search criteria objects
- **filters** (array) - Optional - List of filter objects for specific fields like followers, email existence, or engagement growth

### Request Example
{
  "page": 1,
  "per_page": 20,
  "social_media_matching_operator": "and",
  "criterias": [
    { "type": "should", "field": "all", "value": "lifestyle" }
  ],
  "filters": [
    { "type": "range-int", "field": "instagram.followers", "value": { "from": 50000 } },
    { "type": "existence", "field": "influencer.email", "value": "with" }
  ]
}
```

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

### Retrieve Stream Matches via cURL

Source: https://docs.upfluence.co/docs/examples/track-campaign-content-performance

Fetch individual social media posts that match stream criteria, including engagement data and influencer details.

```bash
curl -X GET "https://analytics.upfluence.co/api/v1/matches?stream_id={stream_id}&page=1&per_page=50&ordering_key=timestamp&ordering_direction=desc" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### POST https://analytics.upfluence.co/api/v1/streams

Source: https://docs.upfluence.co/docs/examples/brand-social-listening

Create a new stream to monitor social media posts based on keyword filters.

```APIDOC
## POST https://analytics.upfluence.co/api/v1/streams

### Description
Create a new stream to monitor social media posts based on filters. A Stream contains a set of filters that allow it to correctly fetch posts matching your criteria.

### Method
POST

### Endpoint
https://analytics.upfluence.co/api/v1/streams

### Request Body
- **stream** (object) - Required - Contains stream name, post_types, and keyword_filters
- **auto_start** (boolean) - Optional - Set to true to begin monitoring immediately

### Request Example
{
  "stream": {
    "name": "YourBrand Social Listening",
    "post_types": ["instagram_media", "tweet", "tiktok_video", "youtube_video"],
    "keyword_filters": [
      {
        "keywords": ["YourBrand"],
        "field_type": "content",
        "post_type": "instagram_media",
        "condition": "include"
      }
    ]
  },
  "auto_start": true
}
```

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

### POST /influencers/{id}/tags

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Apply tags to an influencer for campaign organization.

```APIDOC
## POST https://api.upfluence.co/v1/influencers/{id}/tags

### Description
Apply consistent tagging across influencers for campaign organization.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/tags

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

#### Request Body
- **upsert_tags** (array) - Required - List of tags to apply to the influencer.

### Request Example
{
  "upsert_tags": ["summer-campaign-2024", "tier-1"]
}
```

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

### Set Content-Type Header

Source: https://docs.upfluence.co/docs/introduction

Include this header in all API requests to ensure request bodies are correctly parsed.

```http
Content-Type: application/json
```

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

### Manage Influencer Merge Fields

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Upsert or remove merge fields. Upserting requires slug, name, and value; deletion requires only the slug.

```bash
curl -X POST "https://api.upfluence.co/v1/influencers/{influencer_id}/merge_fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "upsert_merge_fields": [
      {
        "slug": "instagram_recommend_price",
        "name": "Instagram Recommended Price",
        "value": "125€"
      },
      {
        "slug": "preferred_contact_method",
        "name": "Preferred Contact Method",
        "value": "email"
      }
    ],
    "delete_merge_fields": ["old_pricing_field"]
  }'
```

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

### HTTP Status Codes

Source: https://docs.upfluence.co/docs/errors

Overview of standard HTTP response codes returned by the API to indicate success or failure.

```APIDOC
## HTTP Status Codes

| Status Code | Meaning |
| :--- | :--- |
| 200 | OK - Everything worked as expected. |
| 400 | Bad Request - The request was unacceptable, often due to a missing required parameter. |
| 401 | Unauthorized - No valid access token provided. |
| 402 | Payment Required - You exceeded your allocated number of API calls. |
| 404 | Not Found - The requested resource doesn't exist. |
| 500, 502, 503, 504 | Server Errors - Something went wrong on Upfluence's end.
```

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

### Fetch Audience Demographics

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Retrieves detailed audience data such as age, gender, and geographic location for a specific influencer.

```curl
curl -X GET "https://api.upfluence.co/v1/audience?influencer_id={influencer_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### POST /v1/influencers/{id}/tags

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Add or remove tags for an influencer.

```APIDOC
## POST /v1/influencers/{id}/tags

### Description
Add or remove tags for an influencer. Tags in upsert_tags will be added or updated, while tags in delete_tags will be removed.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/tags

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

#### Request Body
- **upsert_tags** (array) - Optional - List of tags to add or update.
- **delete_tags** (array) - Optional - List of tags to remove.
```

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

### Add Influencers to a Stream

Source: https://docs.upfluence.co/docs/examples/brand-social-listening

Registers specific influencers to a stream to monitor their content regardless of keyword mentions.

```curl
curl -X POST "https://analytics.upfluence.co/api/v1/followings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stream_id": {stream_id},
    "followings": [
      {
        "influencer_id": {influencer_id_1}
      },
      {
        "influencer_id": {influencer_id_2}
      }
    ]
  }'
```

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

### Search for Influencers via API

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Uses the matches endpoint to filter influencers by criteria, location, engagement, and audience demographics.

```curl
curl -X POST "https://api.upfluence.co/v1/matches" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "per_page": 20,
    "social_media_matching_operator": "or",
    "criterias": [
      {
        "type": "should",
        "field": "all",
        "value": "fashion beauty"
      },
      {
        "type": "should",
        "field": "all",
        "value": "beauty"
      }
    ],
    "filters": [
      {
        "type": "multi-string",
        "field": "influencer.geo_country",
        "value": ["US"]
      },
      {
        "type": "range-int",
        "field": "instagram.followers",
        "value": {
          "from": 50000,
          "to": 500000
        }
      },
      {
        "type": "average-engagement",
        "field": "instagram",
        "value": 3,
        "order": ">",
        "isPercent": true
      }
    ],
    "audience_filters": [
      {
        "field": "audience.country.US",
        "value": 0.5,
        "order": ">"
      },
      {
        "field": "audience.gender.female",
        "value": 0.6,
        "order": ">"
      }
    ],
    "ordering": {
      "value": "relevancy",
      "direction": "desc"
    }
  }'
```

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

### Fetch Influencer Tags

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Retrieve an array of tag strings currently assigned to an influencer.

```bash
curl -X GET "https://api.upfluence.co/v1/influencers/{influencer_id}/tags" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### Update List Information

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Modifies list details such as name or archive status.

```curl
curl -X PUT "https://api.upfluence.co/v1/lists/{list_id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list": {
      "name": "Summer Fashion Campaign 2024 - Final Selection"
    }
  }'
```

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

### Retrieve Media Audience Stats

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Fetches brand mentions for Instagram or TikTok accounts using the platform-specific ID.

```curl
curl -X GET "https://api.upfluence.co/v1/media/mentions?media_type=instagram&media_id={instagram_id}&limit=5" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### Fetch Influencer Custom Attributes

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Retrieve custom attributes such as contact details, ratings, and shipping information for an influencer.

```bash
curl -X GET "https://api.upfluence.co/v1/influencers/{influencer_id}/attributes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### Retrieve Influencer Profile

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Fetches comprehensive profile data including contact details and social media statistics using an influencer ID.

```curl
curl -X GET "https://api.upfluence.co/v1/influencers/{influencer_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### POST /influencers/{id}/merge_fields

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Manage influencer pricing and rate card information using merge fields.

```APIDOC
## POST https://api.upfluence.co/v1/influencers/{id}/merge_fields

### Description
Use merge fields to store and manage influencer pricing across platforms.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/merge_fields

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

#### Request Body
- **upsert_merge_fields** (array) - Required - List of objects containing slug, name, and value for the merge field.

### Request Example
{
  "upsert_merge_fields": [
    {
      "slug": "instagram_story_rate",
      "name": "Instagram Story Rate",
      "value": "$200"
    }
  ]
}
```

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

### Fetch Influencer Merge Fields

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Retrieve the merge fields assigned to an influencer, which store custom metadata as key-value pairs.

```bash
curl -X GET "https://api.upfluence.co/v1/influencers/{influencer_id}/merge_fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### View Campaign Contributions

Source: https://docs.upfluence.co/docs/examples/monitor-campaign-performance

Retrieve influencer contributions filtered by campaign or influencer ID.

```http
GET
https://publishr.upfluence.co/private/api/v1/contributions
```

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

### Add Influencer to List

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Adds an influencer to a specific list. Entries are created with a 'selected' status by default.

```curl
curl -X POST "https://api.upfluence.co/v1/list_entries" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list_entry": {
      "list_id": 153395,
      "influencer_id": 12986860
    }
  }'
```

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

### DELETE https://api.upfluence.co/v1/list_entries/{id}

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Removes an influencer from a list.

```APIDOC
## DELETE https://api.upfluence.co/v1/list_entries/{id}

### Description
Removes an influencer from a list.

### Method
DELETE

### Endpoint
https://api.upfluence.co/v1/list_entries/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the list entry
```

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

### Fetch Instagram Media

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Retrieves recent Instagram posts for an influencer using their Instagram ID to analyze content performance.

```curl
curl -X GET "https://api.upfluence.co/v1/instagram_medias?instagram_id={instagram_id}&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

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

### POST /v1/influencers/{id}/merge_fields

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Upsert or remove merge fields for an influencer.

```APIDOC
## POST /v1/influencers/{id}/merge_fields

### Description
Upsert or remove merge fields for an influencer. Upserting requires slug, name, and value fields.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/merge_fields

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

#### Request Body
- **upsert_merge_fields** (array) - Optional - List of objects containing slug, name, and value.
- **delete_merge_fields** (array) - Optional - List of merge field slugs to remove.
```

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

### POST /influencers/{id}/attributes

Source: https://docs.upfluence.co/docs/examples/enrich-influencer-profile

Add, update, or remove custom attributes for an influencer profile.

```APIDOC
## POST https://api.upfluence.co/v1/influencers/{id}/attributes

### Description
Add, update or remove custom attributes for an influencer. Valid attribute keys include: email, name, first_name, last_name, address, phone_number, country, rating, gender, and shipping_address.

### Method
POST

### Endpoint
https://api.upfluence.co/v1/influencers/{id}/attributes

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

#### Request Body
- **upsert_fields** (array) - Optional - List of objects containing key and value to add or update.
- **discard_fields** (array) - Optional - List of attribute keys to remove.

### Request Example
{
  "upsert_fields": [
    {
      "key": "first_name",
      "value": "Sarah"
    },
    {
      "key": "rating",
      "value": 5
    }
  ],
  "discard_fields": ["last_name"]
}
```

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

### Search Influencers by Engagement Growth and Activity

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Targets fashion influencers with over 10,000 followers, an engagement growth rate above 10, and recent posting activity within the last 3 months.

```curl
curl -X POST "https://api.upfluence.co/v1/matches" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "per_page": 20,
    "criterias": [
      {
        "type": "should",
        "field": "all",
        "value": "fashion"
      }
    ],
    "filters": [
      {
        "type": "range-int",
        "field": "instagram.followers",
        "value": {
          "from": 10000
        }
      },
      {
        "type": "float",
        "field": "instagram.engagement_growth_rate",
        "value": 10,
        "order": ">"
      },
      {
        "type": "date-range",
        "field": "instagram.medias.timestamp",
        "value": "3mo",
        "order": "<"
      }
    ]
  }'
```

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

### Search Multi-Platform Influencers with Contact

Source: https://docs.upfluence.co/docs/examples/search-and-analyze-influencers

Filters for influencers active on both Instagram and TikTok with at least 50,000 followers on each and an available email address.

```curl
curl -X POST "https://api.upfluence.co/v1/matches" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "per_page": 20,
    "social_media_matching_operator": "and",
    "criterias": [
      {
        "type": "should",
        "field": "all",
        "value": "lifestyle"
      }
    ],
    "filters": [
      {
        "type": "range-int",
        "field": "instagram.followers",
        "value": {
          "from": 50000
        }
      },
      {
        "type": "range-int",
        "field": "tiktok.followers",
        "value": {
          "from": 50000
        }
      },
      {
        "type": "existence",
        "field": "influencer.email",
        "value": "with"
      }
    ]
  }'
```

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

### Remove Influencer from List

Source: https://docs.upfluence.co/docs/examples/manage-influencer-lists

Removes an influencer from a specific list without affecting their presence in other lists.

```curl
curl -X DELETE "https://api.upfluence.co/v1/list_entries/{list_entry_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
```
Tokens:
Raw