Media Properties

Endpoints for listing, creating, retrieving, updating, and deleting partner media properties.

List all media properties

get

Lists all media properties for your account.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Responses

200

OK

application/json

get/Mediapartners/{AccountSID}/MediaProperties

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/MediaProperties' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "MediaProperties": [
    {
      "Id": "4622773",
      "Name": "Hazel Nutt's Instagram",
      "Thumbnail": "/Mediapartners/<AccountSID>/MediaProperties/4622773/Thumbnail",
      "Description": "Hazel Nutt's official Instagram account covering lifestyle and wellness.",
      "Tags": "lifestyle,wellness,beauty",
      "RevenueModel": [
        "PAY_PER_SALE"
      ],
      "Url": "https://www.instagram.com/hazelnuttofficial",
      "Type": "SOCIAL",
      "MonthlyUniqueVisitors": "",
      "AlexaRating": "",
      "QuantcastRating": "",
      "OwnershipVerified": "true",
      "MobilePlatform": "IOS",
      "AppStoreRating": "",
      "Installs": "HUNDRED_PLUS",
      "Price": "",
      "SocialPlatform": "INSTAGRAM",
      "Followers": "HUNDRED_THOUSAND_PLUS",
      "Handle": "@hazelnuttofficial",
      "Uri": "/Mediapartners/<AccountSID>/MediaProperties/4622773"
    }
  ]
}

Create a media property

post

Creates a new media property object. New media properties need to be verified by impact.com before they are fully approved.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Body

multipart/form-data

NamestringRequired

Display name of the media property.

Typestring · enumRequired

The type of media property — website, mobile app, or social media account.

Possible values:

UrlstringRequired

The URL of the media property.

MobilePlatformstring · enumOptional

The mobile operating system platform the app is published on.

Possible values:

AppStoreRatinginteger · min: 1 · max: 5Optional

App store rating out of 5. Applies to MOBILE type properties.

Installsstring · enumOptional

Tiered count buckets for app installs (MOBILE) or social followers (SOCIAL).

Possible values:

SocialPlatformstring · enumOptional

The social media platform the property is on.

Possible values:

Followersstring · enumOptional

Tiered count buckets for app installs (MOBILE) or social followers (SOCIAL).

Possible values:

Thumbnailstring · binaryOptional

Thumbnail image for the media property, as a binary upload.

DescriptionstringOptional

A description of the media property and its audience.

TagsstringOptional

Comma-separated tags used to categorize this media property.

RevenueModelstring · enumOptional

The monetization model(s) used by this media property.

Possible values:

MonthlyUniqueVisitorsintegerOptional

Estimated monthly unique visitors. Applies to WEBSITE type properties.

AlexaRatingintegerOptional

Alexa global traffic rank for this media property. Applies to WEBSITE type properties.

QuantcastRatingintegerOptional

Quantcast audience measurement rating. Applies to WEBSITE type properties.

PriceintegerOptional

The price of the app in the app store. Applies to MOBILE type properties.

HandlestringOptional

The social media handle or username for this property. Applies to SOCIAL type properties.

Responses

201

Created

application/json

StatusstringOptionalExample: OK

UristringOptionalExample: /Mediapartners/<AccountSID>/MediaProperties/4622773

post/Mediapartners/{AccountSID}/MediaProperties

curl

curl -L \
  --request POST \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/MediaProperties' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

201

Created

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/MediaProperties/4622773"
}

Retrieve a media property

get

Retrieves a media property for the specified Id value.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the media property.

Responses

200

OK

application/json

IdstringOptional

Unique identifier for the media property.

Example: 4622773

NamestringOptional

Display name of the media property.

Example: Hazel Nutt's Instagram

ThumbnailstringOptional

API resource path to the thumbnail image for this media property, if one has been uploaded.

Example: /Mediapartners/<AccountSID>/MediaProperties/4622773/Thumbnail

DescriptionstringOptional

A description of the media property and its audience.

Example: Hazel Nutt's official Instagram account covering lifestyle and wellness.

TagsstringOptional

Comma-separated tags used to categorize this media property.

Example: lifestyle,wellness,beauty

UrlstringOptional

The URL of the media property.

Example: https://www.instagram.com/hazelnuttofficial

Typestring · enumOptional

The type of media property.

Example: SOCIALPossible values:

MonthlyUniqueVisitorsstringOptional

Estimated monthly unique visitors. Applies to WEBSITE type properties.

AlexaRatingstringOptional

Alexa global traffic rank for this media property. Applies to WEBSITE type properties.

QuantcastRatingstringOptional

Quantcast audience measurement rating. Applies to WEBSITE type properties.

OwnershipVerifiedstringOptional

Indicates whether ownership of this media property has been verified by impact.com.

Example: true

MobilePlatformstring · enumOptional

The mobile platform this app is published on. Applies to MOBILE type properties.

Possible values:

AppStoreRatingstringOptional

App store rating out of 5. Applies to MOBILE type properties.

Installsstring · enumOptional

Estimated number of installs. Applies to MOBILE type properties.

Possible values:

PricestringOptional

The price of the app in the app store. Applies to MOBILE type properties.

SocialPlatformstring · enumOptional

The social media platform this property is on. Applies to SOCIAL type properties.

Example: INSTAGRAMPossible values:

Followersstring · enumOptional

Estimated number of followers or subscribers. Applies to SOCIAL type properties.

Example: HUNDRED_THOUSAND_PLUSPossible values:

HandlestringOptional

The social media handle or username for this property. Applies to SOCIAL type properties.

Example: @hazelnuttofficial

UristringOptional

Unique reference to this media property in the impact.com API.

Example: /Mediapartners/<AccountSID>/MediaProperties/4622773

get/Mediapartners/{AccountSID}/MediaProperties/{Id}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/MediaProperties/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "Id": "4622773",
  "Name": "Hazel Nutt's Instagram",
  "Thumbnail": "/Mediapartners/<AccountSID>/MediaProperties/4622773/Thumbnail",
  "Description": "Hazel Nutt's official Instagram account covering lifestyle and wellness.",
  "Tags": "lifestyle,wellness,beauty",
  "RevenueModel": [
    "PAY_PER_SALE"
  ],
  "Url": "https://www.instagram.com/hazelnuttofficial",
  "Type": "SOCIAL",
  "MonthlyUniqueVisitors": "",
  "AlexaRating": "",
  "QuantcastRating": "",
  "OwnershipVerified": "true",
  "MobilePlatform": "IOS",
  "AppStoreRating": "",
  "Installs": "HUNDRED_PLUS",
  "Price": "",
  "SocialPlatform": "INSTAGRAM",
  "Followers": "HUNDRED_THOUSAND_PLUS",
  "Handle": "@hazelnuttofficial",
  "Uri": "/Mediapartners/<AccountSID>/MediaProperties/4622773"
}

Update a media property

put

Updates the specified media property's attributes. Submitted parameter values will overwrite an attribute's existing value entirely.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the media property.

Body

multipart/form-data

NamestringOptional

Display name of the media property.

Thumbnailstring · binaryOptional

Thumbnail image for the media property, as a binary upload.

DescriptionstringOptional

A description of the media property and its audience.

TagsstringOptional

Comma-separated tags used to categorize this media property.

RevenueModelstring · enumOptional

The monetization model(s) used by this media property.

Possible values:

UrlstringOptional

The URL of the media property.

MonthlyUniqueVisitorsintegerOptional

Estimated monthly unique visitors. Applies to WEBSITE type properties.

AlexaRatingintegerOptional

Alexa global traffic rank for this media property. Applies to WEBSITE type properties.

QuantcastRatingintegerOptional

Quantcast audience measurement rating. Applies to WEBSITE type properties.

MobilePlatformstring · enumOptional

The mobile operating system platform the app is published on.

Possible values:

AppStoreRatingintegerOptional

App store rating out of 5. Applies to MOBILE type properties.

PriceintegerOptional

The price of the app in the app store. Applies to MOBILE type properties.

Installsstring · enumOptional

Tiered count buckets for app installs (MOBILE) or social followers (SOCIAL).

Possible values:

SocialPlatformstring · enumOptional

The social media platform the property is on.

Possible values:

Followersstring · enumOptional

Tiered count buckets for app installs (MOBILE) or social followers (SOCIAL).

Possible values:

HandlestringOptional

The social media handle or username for this property. Applies to SOCIAL type properties.

Responses

200

OK

application/json

StatusstringOptionalExample: OK

UristringOptionalExample: /Mediapartners/<AccountSID>/MediaProperties/4622773

put/Mediapartners/{AccountSID}/MediaProperties/{Id}

curl

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/MediaProperties/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/MediaProperties/4622773"
}

Delete a media property

delete

Permanently deletes the specified media property. This cannot be undone.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the media property.

Responses

200

DELETED

application/json

StatusstringOptionalExample: DELETED

delete/Mediapartners/{AccountSID}/MediaProperties/{Id}

curl

curl -L \
  --request DELETE \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/MediaProperties/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

DELETED

{
  "Status": "DELETED"
}