Back to top

IZEAx V1 API (Beta)

The IZEAx API allows you to connect to your IZEAx Campaigns programmatically. Using this API you can enumerate your Campaigns and then retrieve information and metrics about the Offers in each one.

Authentication

In order to successfully call the IZEAx API you will need an Authentication Token. You can create an Authentication Token in the Account Settings tab of IZEAx. This token must be passed in the Authentication header of your request as follows.

Please note that, as this is a Beta program, we may need to enable the API Token tab for your account. Please reach out to your customer success representative for access.

Authorization: Bearer: <token>

Authorization

You must also pass the ID of the Account that you are working with through the X-IZEA-Account-ID header. Your Account ID can be found on the API Token tab in IZEAx. Please reach out to your customer success representative for access.

X-IZEA-Account-ID: <accountid>

Campaigns

Campaigns

Get Campaigns
GET/campaigns

Use this request to retrieve information about, and enumerate all of your Campaigns in IZEAx. In order to call the /metrics endpoint, you must have a campaign id, so use this endpoint to start.

Example URI

GET https://api-v1.izea.com/campaigns
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": "6",
      "campaign_type": "sponsorship",
      "name": "My Campaign"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

Metrics

Metrics

Get Metrics
GET/metrics{?campaignid,page}

Once you have a campaign ID, use this endpoint to retrieve a paginated set of Offers for the Campaign. Each Offer will come with the last 30 days of metrics.

This endpoint is paginated with a page size of 10. If your campaign has more Offers than that, a link to the next page will be provided in the response.

The platform_data field in the response will vary depending on what platform the Offer was published on. The values will be as follows:

  • blogs:

    • comments
  • facebook

    • comments
    • likes
    • shares
    • views
  • instagram:

    • comments
    • likes
    • views
  • twitter

    • likes
    • replies
    • retweets
  • youtube

    • comments
    • likes
    • views

Example URI

GET https://api-v1.izea.com/metrics?campaignid=6&page=1
URI Parameters
HideShow
campaignid
string (required) Example: 6

The ID of the campaign to retrieve metrics for.

page
number (optional) Example: 1

The page of offers to retrieve. 1 if not specified.

Response  200
HideShow
Body
{
  "data": {
    "offers": [
      {
        "id": "10000",
        "published_at": "2018-01-01T02:45:90.000-05:00",
        "published_url": "http://twitter.com/izea/",
        "reach_when_published": 3000,
        "connection_name": "@izea",
        "platform": "twitter",
        "connection_url": "http://twitter.com/izea",
        "metrics": [
          {
            "metric_on": "2018-01-01",
            "platform_data": {
              "comments": 2,
              "likes": 312,
              "loops": 77,
              "reblogs": 436,
              "shares": 12,
              "replies": 8,
              "retweets": 1,
              "views": 234
            },
            "total_clicks_to_date": 76,
            "total_views_to_date": 400
          }
        ]
      }
    ]
  },
  "links": {
    "_next": "https://api-v1.izea.com/metrics?campaignif=6&page=4",
    "_prev": "https://api-v1.izea.com/metrics?campaignif=6&page=2"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "offers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "published_at": {
                "type": "string"
              },
              "published_url": {
                "type": "string"
              },
              "reach_when_published": {
                "type": "number"
              },
              "connection_name": {
                "type": "string"
              },
              "platform": {
                "type": "string"
              },
              "connection_url": {
                "type": "string"
              },
              "metrics": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "metric_on": {
                      "type": "string"
                    },
                    "platform_data": {
                      "type": "object",
                      "properties": {
                        "comments": {
                          "type": "number"
                        },
                        "likes": {
                          "type": "number"
                        },
                        "loops": {
                          "type": "number"
                        },
                        "reblogs": {
                          "type": "number"
                        },
                        "shares": {
                          "type": "number"
                        },
                        "replies": {
                          "type": "number"
                        },
                        "retweets": {
                          "type": "number"
                        },
                        "views": {
                          "type": "number"
                        }
                      }
                    },
                    "total_clicks_to_date": {
                      "type": "number"
                    },
                    "total_views_to_date": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "_next": {
          "type": "string"
        },
        "_prev": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Generated by aglio on 19 Mar 2019