Insights

Insights by agent email - daily breakdown

post

This endpoint retrieves daily campaign insights for a specific agent over a defined date range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and agentEmail (String), which filter the campaign data based on the reporting date and the agent's email. The endpoint returns a detailed set of data for each day within the specified period, including information such as the agent's email, name, and external ID, along with the campaign name, daily frequency, branch name, and flow-related details (such as campaign ID and property ID). It also aggregates key metrics for each day, including impressions, link clicks, post engagements, reach, and gender/age bracket breakdowns.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

agentEmailstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/daily/agent/email

application/json

post

/api/rest/v2/insights/daily/agent/email

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/daily/agent/email HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "agentEmail": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/daily/agent/email

{
  "facebookDailyInsights": [
    {
      "ageBracket": "text",
      "agentEmail": "text",
      "agentExternalId": "text",
      "agentFirstName": "text",
      "agentLastName": "text",
      "branchName": "text",
      "campaignName": "text",
      "dailyFrequency": 1,
      "externalBranchId": "text",
      "flowCampaignId": "text",
      "flowPropertyId": "text",
      "gender": "text",
      "impressions": 1,
      "linkClicks": 1,
      "listingReference": "text",
      "postEngagements": 1,
      "reach": 1,
      "reportingDate": null
    }
  ]
}

Insights by agent external id - daily breakdown

post

This endpoint retrieves daily campaign insights for a specific agent, identified by their external ID, over a defined date range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and agentExternalId (String), which filter the data based on the reporting date and the agent's external ID. The endpoint returns detailed insights for each day within the specified period, including the agent's external ID, name, email, and branch name, along with campaign-related information such as the campaign name, frequency, and flow campaign and property IDs. Additionally, the data includes key metrics such as impressions, link clicks, post engagements, reach, as well as demographic details like age bracket and gender.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

agentExternalIdstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/daily/agent/externalId

application/json

post

/api/rest/v2/insights/daily/agent/externalId

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/daily/agent/externalId HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "agentExternalId": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/daily/agent/externalId

{
  "facebookDailyInsights": [
    {
      "ageBracket": "text",
      "agentEmail": "text",
      "agentExternalId": "text",
      "agentFirstName": "text",
      "agentLastName": "text",
      "branchName": "text",
      "campaignName": "text",
      "dailyFrequency": 1,
      "externalBranchId": "text",
      "flowCampaignId": "text",
      "flowPropertyId": "text",
      "gender": "text",
      "impressions": 1,
      "linkClicks": 1,
      "listingReference": "text",
      "postEngagements": 1,
      "reach": 1,
      "reportingDate": null
    }
  ]
}

Insights by listing - daily breakdown

post

This endpoint retrieves daily campaign insights based on a specific listing reference and branch ID, within a defined date range. It takes four parameters: startDate (Timestamp), endDate (Timestamp), listingReference (String), and branchId (String), which filter the data based on the reporting date, the listing reference, and the branch's external ID. The endpoint returns detailed daily insights for each campaign associated with the given listing reference and branch, including agent details (email, external ID, first and last names), campaign name, and flow-related information (campaign ID, property ID). It also includes key performance metrics such as impressions, link clicks, post engagements, reach, as well as demographic breakdowns (age bracket and gender).

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

branchIdstringOptional

endDateanyOptional

listingReferencestringOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/daily/listing

application/json

post

/api/rest/v2/insights/daily/listing

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/daily/listing HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "branchId": "text",
  "endDate": null,
  "listingReference": "text",
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/daily/listing

{
  "facebookDailyInsights": [
    {
      "ageBracket": "text",
      "agentEmail": "text",
      "agentExternalId": "text",
      "agentFirstName": "text",
      "agentLastName": "text",
      "branchName": "text",
      "campaignName": "text",
      "dailyFrequency": 1,
      "externalBranchId": "text",
      "flowCampaignId": "text",
      "flowPropertyId": "text",
      "gender": "text",
      "impressions": 1,
      "linkClicks": 1,
      "listingReference": "text",
      "postEngagements": 1,
      "reach": 1,
      "reportingDate": null
    }
  ]
}

Insights by branch - daily breakdown

post

This endpoint retrieves daily Facebook campaign insights for a specific branch over a defined date range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and branchId (String), which filter the data based on the reporting date and the branch's external ID. The endpoint returns detailed daily insights for each campaign within the specified time period, including the branch name, agent information (such as email, external ID, first and last names), and campaign details (such as campaign name and frequency). It also provides key performance metrics like impressions, link clicks, post engagements, reach, and demographic data such as age bracket and gender.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

branchIdstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/daily/branch

application/json

post

/api/rest/v2/insights/daily/branch

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/daily/branch HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "branchId": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/daily/branch

{
  "facebookDailyInsights": [
    {
      "ageBracket": "text",
      "agentEmail": "text",
      "agentExternalId": "text",
      "agentFirstName": "text",
      "agentLastName": "text",
      "branchName": "text",
      "campaignName": "text",
      "dailyFrequency": 1,
      "externalBranchId": "text",
      "flowCampaignId": "text",
      "flowPropertyId": "text",
      "gender": "text",
      "impressions": 1,
      "linkClicks": 1,
      "listingReference": "text",
      "postEngagements": 1,
      "reach": 1,
      "reportingDate": null
    }
  ]
}

Insights by campaign external reference - daily breakdown

post

This endpoint retrieves daily campaign insights based on a specific external reference, within a defined date range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and externalref (String), which filter the data according to the reporting date and the external reference ID. The endpoint returns detailed insights for each day within the specified period, including information such as the agent’s email, external ID, first and last names, and the branch name. It also provides campaign details like the campaign name, frequency, and flow-related IDs. Additionally, key metrics like impressions, link clicks, post engagements, reach, as well as demographic information (age bracket, gender), and the external reference ID are included.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

endDateanyOptional

externalrefstringOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/daily/externalref

application/json

post

/api/rest/v2/insights/daily/externalref

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/daily/externalref HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "endDate": null,
  "externalref": "text",
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/daily/externalref

{
  "FacebookDailyInsights": [
    {
      "ageBracket": "text",
      "agentEmail": "text",
      "agentExternalId": "text",
      "agentFirstName": "text",
      "agentLastName": "text",
      "branchName": "text",
      "campaignName": "text",
      "dailyFrequency": 1,
      "externalBranchId": "text",
      "externalRef": "text",
      "flowCampaignId": "text",
      "flowPropertyId": "text",
      "gender": "text",
      "impressions": 1,
      "linkClicks": 1,
      "listingReference": "text",
      "postEngagements": 1,
      "reach": 1,
      "reportingDate": null
    }
  ]
}

Insights by agent email - aggregated between selected dates

post

This endpoint is designed to retrieve campaign insights for a specific agent within a defined time range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and agentEmail (String), which filter the campaign data based on the reporting date and the agent's email. The endpoint returns two sets of aggregated insights: the first (facebookCampaigns) provides the total count of distinct Facebook campaigns within the specified period for the given agent. The second set (facebookAggregateInsights) aggregates key metrics like impressions, link clicks, post engagements, and reach across all campaigns that meet the filtering criteria.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

agentEmailstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/aggregated/agent/email

application/json

post

/api/rest/v2/insights/aggregated/agent/email

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/aggregated/agent/email HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "agentEmail": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/aggregated/agent/email

{
  "facebookAggregateInsights": {
    "total": {
      "sum": {
        "impressions": 1,
        "linkClicks": 1,
        "postEngagements": 1,
        "reach": 1
      }
    }
  },
  "facebookCampaigns": {
    "total": {
      "count": 1
    }
  }
}

Insights by agent external id - aggregated between selected dates

post

This endpoint retrieves campaign insights for a specific agent, identified by their external ID, within a given time range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and agentExternalId (String). The endpoint returns two sets of aggregated insights: the first (facebookCampaigns) counts the distinct Facebook campaigns associated with the given agent's external ID within the specified date range. The second (facebookAggregateInsights) aggregates key metrics such as impressions, link clicks, post engagements, and reach for the campaigns in the specified period.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

agentExternalIdstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/aggregated/agent/externalId

application/json

post

/api/rest/v2/insights/aggregated/agent/externalId

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/aggregated/agent/externalId HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "agentExternalId": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/aggregated/agent/externalId

{
  "facebookAggregateInsights": {
    "total": {
      "sum": {
        "impressions": 1,
        "linkClicks": 1,
        "postEngagements": 1,
        "reach": 1
      }
    }
  },
  "facebookCampaigns": {
    "total": {
      "count": 1
    }
  }
}

Insights by listing - aggregated between selected dates

post

This endpoint retrieves aggregated insights for campaigns based on a specific listing reference, branch ID, and date range. It takes four parameters: listingReference (String), branchId (String), startDate (Timestamp), and endDate (Timestamp). The endpoint returns two sets of aggregated data: First, the facebookCampaigns set provides the total count of distinct Facebook campaigns associated with the given listing reference and branch within the specified date range. Second, the facebookAggregateInsights set aggregates key metrics such as impressions, link clicks, post engagements, and reach for the campaigns that meet the filtering criteria.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

branchIdstringOptional

endDateanyOptional

listingReferencestringOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/aggregated/listing

application/json

post

/api/rest/v2/insights/aggregated/listing

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/aggregated/listing HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "branchId": "text",
  "endDate": null,
  "listingReference": "text",
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/aggregated/listing

{
  "facebookAggregateInsights": {
    "total": {
      "sum": {
        "impressions": 1,
        "linkClicks": 1,
        "postEngagements": 1,
        "reach": 1
      }
    }
  },
  "facebookCampaigns": {
    "total": {
      "count": 1
    }
  }
}

Insights by branch - aggregated between selected dates

post

This endpoint retrieves aggregated insights for campaigns associated with a specific branch within a given time range. It takes three parameters: startDate (Timestamp), endDate (Timestamp), and branchId (String), which filter the campaign data based on the reporting date and the branch's external ID. The endpoint returns two sets of aggregated insights: the first (facebookCampaigns) counts the distinct Facebook campaigns associated with the specified branch ID within the defined date range. The second (facebookAggregateInsights) aggregates key performance metrics, including impressions, link clicks, post engagements, and reach, for the campaigns meeting the filter criteria. This API is useful for obtaining a branch-level summary of Facebook campaign performance over a specified time period.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

branchIdstringOptional

endDateanyOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/aggregated/branch

application/json

post

/api/rest/v2/insights/aggregated/branch

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/aggregated/branch HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "branchId": "text",
  "endDate": null,
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/aggregated/branch

{
  "facebookAggregateInsights": {
    "total": {
      "sum": {
        "impressions": 1,
        "linkClicks": 1,
        "postEngagements": 1,
        "reach": 1
      }
    }
  },
  "facebookCampaigns": {
    "total": {
      "count": 1
    }
  }
}

Insights by campaign external reference - aggregated between selected dates

post

This endpoint is designed to provide aggregated insights for campaigns linked to a specific external reference within a defined date range. It takes three parameters: externalref (String), startDate (Timestamp), and endDate (Timestamp). The endpoint returns three main sets of data: First, the facebookAggregateInsights which aggregates key metrics such as impressions, link clicks, post engagements, and reach for campaigns within the specified date range, along with a count of distinct campaigns identified by their flow campaign ID. Second, the Campaigns set provides the total count of campaigns linked to the external reference in the given period. Finally, the endpoint returns a list of unique external references associated with the campaigns.

Header parameters

flow-api-user-idstringOptional

Your flow-api-user-id will be used for authentication of the API request.

flow-api-user-secretstringOptional

Your flow-api-user-secret will be used for authentication of the API request.

Body

application/json

endDateanyOptional

externalrefstringOptional

startDateanyOptional

Responses

200

Responses for POST /api/rest/v2/insights/aggregated/externalref

application/json

post

/api/rest/v2/insights/aggregated/externalref

HTTPcURLJavaScriptPython

POST /api/rest/v2/insights/aggregated/externalref HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "endDate": null,
  "externalref": "text",
  "startDate": null
}

200

Responses for POST /api/rest/v2/insights/aggregated/externalref

{
  "Campaigns": {
    "Total": {
      "count": 1
    }
  },
  "external_sharing_facebookCampaignInsights_insightLevel": [
    {
      "externalRef": "text"
    }
  ],
  "facebookAggregateInsights": {
    "Total": {
      "TotalFacebookCampaigns": 1,
      "sum": {
        "impressions": 1,
        "link_clicks": 1,
        "post_engagements": 1,
        "reach": 1
      }
    }
  }
}