import { ConfigurationError } from "@pipedream/platform";
import servicenow from "../../servicenow.app.mjs";
export default {
key: "servicenow-get-record-counts-by-field",
name: "Get Record Counts by Field",
description: "Retrieves the count of records grouped by a specified field from a ServiceNow table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats)",
version: "0.0.1",
annotations: {
destructiveHint: false,
openWorldHint: true,
readOnlyHint: true,
},
type: "action",
props: {
servicenow,
table: {
propDefinition: [
servicenow,
"table",
],
},
groupByField: {
type: "string",
label: "Group By Field",
description: "The field to group records by (e.g., `priority`, `state`, `category`)",
},
count: {
type: "boolean",
label: "Count",
description: "If true, returns the number of records returned by the query",
optional: true,
default: true,
},
query: {
label: "Query",
type: "string",
description: "An [encoded query string](https://www.servicenow.com/docs/bundle/zurich-platform-user-interface/page/use/using-lists/concept/c_EncodedQueryStrings.html) to filter records before aggregation (e.g., `active=true^priority=1`)",
optional: true,
},
aggregateInfo: {
type: "alert",
alertType: "info",
content: "You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.",
},
avgFields: {
type: "string[]",
label: "Average Aggregate Fields",
description: "Numeric fields to calculate averages for (e.g., `reassignment_count`, `reopen_count`)",
optional: true,
},
minFields: {
type: "string[]",
label: "Minimum Aggregate Fields",
description: "Numeric fields to find minimum values for",
optional: true,
},
maxFields: {
type: "string[]",
label: "Maximum Aggregate Fields",
description: "Numeric fields to find maximum values for",
optional: true,
},
sumFields: {
type: "string[]",
label: "Sum Aggregate Fields",
description: "Numeric fields to calculate sums for",
optional: true,
},
havingQuery: {
type: "string",
label: "Having Query",
description: "Filter the aggregated results (e.g., `COUNT>10` to only show groups with more than 10 records)",
optional: true,
},
responseDataFormat: {
propDefinition: [
servicenow,
"responseDataFormat",
],
},
orderBy: {
type: "string",
label: "Order By",
description: "Field to sort results by. Prefix with `^ORDER_BY` for ascending or `^ORDER_BYDESC` for descending (e.g., `^ORDER_BYDESC` + field name)",
optional: true,
},
},
async run({ $ }) {
const params = {
sysparm_count: this.count,
sysparm_query: this.query,
sysparm_group_by: this.groupByField,
sysparm_display_value: this.responseDataFormat,
sysparm_having: this.havingQuery,
sysparm_order_by: this.orderBy,
};
let hasAggregateFields = false;
if (this.avgFields?.length) {
params.sysparm_avg_fields = this.avgFields.join?.() || this.avgFields;
hasAggregateFields = true;
}
if (this.minFields?.length) {
params.sysparm_min_fields = this.minFields.join?.() || this.minFields;
hasAggregateFields = true;
}
if (this.maxFields?.length) {
params.sysparm_max_fields = this.maxFields.join?.() || this.maxFields;
hasAggregateFields = true;
}
if (this.sumFields?.length) {
params.sysparm_sum_fields = this.sumFields.join?.() || this.sumFields;
hasAggregateFields = true;
}
if (!hasAggregateFields) {
throw new ConfigurationError("You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.");
}
const response = await this.servicenow.getRecordCountsByField({
$,
table: this.table,
params,
});
$.export("$summary", `Successfully retrieved ${response?.length || 0} records grouped by field "${this.groupByField}"`);
return response;
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.