Segment

App · 20 actions

Read and manage Segment sources, destinations, tracking plans, user groups and workspace configuration.

Actions

ActionWhat it does
Create tracking planCreate tracking plan.
Create user groupCreate user group.
Delete tracking planDelete tracking plan.
Delete user groupDelete user group.
Get destinationGet destination.
Get sourceGet source.
Get tracking planGet tracking plan.
Get user groupGet user group.
Get warehouseGet warehouse.
List destinationsList destinations.
List labelsList labels.
List sourcesList sources.
List tracking plansList tracking plans.
List user groupsList user groups.
List usersList users.
List warehousesList warehouses.
Update destinationUpdate destination.
Update sourceUpdate source.
Update tracking planUpdate tracking plan.
Update user groupUpdate user group.

Create tracking plan

Create tracking plan.

Inputs

NamenametextRequired
The Tracking Plan's name. Config API note: equal to `displayName`.
Descriptiondescriptiontext
The Tracking Plan's description.
TypetypetextRequired
The Tracking Plan's type.One of: ENGAGE, LIVE, PROPERTY_LIBRARY, RULE_LIBRARY, TEMPLATE.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "trackingPlan": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create user group

Create user group.

Inputs

NamenametextRequired
The name of the user group to create.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "userGroup": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete tracking plan

Delete tracking plan.

Inputs

Tracking plantracking_plan_idtextRequired
trackingPlanId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "status": "SUCCESS"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete user group

Delete user group.

Inputs

User group iduser_group_idtextRequired
userGroupId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "status": "SUCCESS"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get destination

Get destination.

Inputs

Destinationdestination_idtextRequired
destinationId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "destination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get source

Get source.

Inputs

Sourcesource_idtextRequired
sourceId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "source": {},
      "trackingPlanId": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get tracking plan

Get tracking plan.

Inputs

Tracking plantracking_plan_idtextRequired
trackingPlanId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "trackingPlan": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get user group

Get user group.

Inputs

User group iduser_group_idtextRequired
userGroupId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "userGroup": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get warehouse

Get warehouse.

Inputs

Warehouse idwarehouse_idtextRequired
warehouseId.From 1 to 255.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "warehouse": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

List destinations

List destinations. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Records per page, 1 to 1000.From 1 to 1000.
Cursorcursortext
Continuation value from the previous page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "destinations": [],
      "pagination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

List labels

List labels.

Inputs

None.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "labels": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

List sources

List sources. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Records per page, 1 to 1000.From 1 to 1000.
Cursorcursortext
Continuation value from the previous page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "pagination": {},
      "sources": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

List tracking plans

List tracking plans. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Records per page, 1 to 1000.From 1 to 1000.
Cursorcursortext
Continuation value from the previous page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "pagination": {},
      "trackingPlans": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

List user groups

List user groups. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Records per page, 1 to 1000.From 1 to 1000.
Cursorcursortext
Continuation value from the previous page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "pagination": {},
      "userGroups": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

List users

List users. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Count.
Cursorcursortext
Cursor.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "pagination": {},
      "users": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

List warehouses

List warehouses. Returns one page; use the continuation value for more records.

Inputs

Countcountnumber
Records per page, 1 to 1000.From 1 to 1000.
Cursorcursortext
Continuation value from the previous page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "pagination": {},
      "warehouses": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update destination

Update destination.

Inputs

Destinationdestination_idtextRequired
destinationId.From 1 to 255.
Namenametext
Defines the display name of the Destination. Config API note: equal to `displayName`.
Enabledenabledtrue/false
Whether this Destination should receive data.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "destination": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update source

Update source.

Inputs

Sourcesource_idtextRequired
sourceId.From 1 to 255.
Namenametext
An optional human-readable name to associate with the Source. Config API note: equal to `displayName`.
Enabledenabledtrue/false
Enable to allow the Source to send data.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "source": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update tracking plan

Update tracking plan.

Inputs

Tracking plantracking_plan_idtextRequired
trackingPlanId.From 1 to 255.
Namenametext
The Tracking Plan's name. Config API note: equal to `displayName`.
Descriptiondescriptiontext
The Tracking Plan's description.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "status": "SUCCESS"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update user group

Update user group.

Inputs

User group iduser_group_idtextRequired
userGroupId.From 1 to 255.
NamenametextRequired
The intended value to rename the user group to.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "userGroup": {}
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page