Ecommerce Product Activity

Ecommerce product activity report for Facebook Ad

Available methods

    • No Summary

      GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity

      Get breakdown of product activity for an outreach

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.
      sort_field Type: String Title: Sort By Field Read only: false Returns files sorted by the specified field.
      Possible Values:
      • title
      • total_revenue
      • total_purchased

      Response body parameters

      products Type: Array Title: No Title Read only: false No Description
      Show properties
      title Type: String Title: No Title Read only: false No Description
      sku Type: String Title: No Title Read only: false No Description
      image_url Type: String Title: No Title Read only: false No Description
      total_revenue Type: Number Title: No Title Read only: false No Description
      total_purchased Type: Number Title: No Title Read only: false No Description
      currency_code Type: String Title: No Title Read only: false No Description
      recommendation_total Type: Integer Title: No Title Read only: false No Description
      recommendation_purchased Type: Integer Title: No Title Read only: false No Description
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.