Skip to content

Commit c3457d4

Browse files
authored
Merge pull request #413 from Invoca/JETS-487_update_signal_api_doc_for_universal_transaction_rollup
JETS-487: Update Signal API Doc to Reflect Universal Transaction Rollup
2 parents c5fa739 + 710b88d commit c3457d4

File tree

1 file changed

+0
-21
lines changed

1 file changed

+0
-21
lines changed

source/api_documentation/signal_api/index.rst

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -375,9 +375,6 @@ For example, if you pass an **advertiser_id_from_network** that you do not have
375375
376376
Signal Transactions Rollup
377377
-------------------------------
378-
**Note**: This specific section only applies if you have begun using the Signal Transactions Rollup feature. This will only apply to calls that occur **after** the date that this feature is enabled.
379-
If you are unsure about whether you are using this feature, please contact the Invoca Customer Successs team.
380-
381378
All Signals and Custom Data within a single request will be grouped together based on the value of the field **partner_unique_id**. There will be a single transaction for each group created.
382379
These new transactions will have the transaction type *Post Call Event*.
383380

@@ -461,10 +458,6 @@ We no longer support specifying **revenue** at the top level header of the reque
461458
462459
Updates and Idempotency
463460
-----------------------
464-
**Notice for users of the Signal Transactions Rollup feature:**
465-
466-
If you are using the Signal Transactions Rollup feature (see section *Signal Transactions Rollup* above), some of the Updates and Idempotency information below has changed slightly.
467-
468461
Signals and Custom Data are considered unique by **partner_unique_id** only; name is *not* considered. Signals and Custom data are grouped into transactions according to **partner_unique_id**.
469462
If a request supplies the same **partner_unique_id** as a previous transaction, the previous transaction will be updated with the content of the new request.
470463

@@ -598,17 +591,3 @@ Note: As signals are applied to the call, the response time of the API will incr
598591
curl -k -H "Content-Type: application/json" -X POST -d '{"search": {"transaction_id": "00000000-00000001"},"signals": [{"name": "sale","partner_unique_id": "1","occurred_at_time": "1440607313","revenue": "100.00","value": "true"}], "custom_data": [{"name": "channel", "value": "Paid Search"}],"oauth_token": <YOUR OAUTH TOKEN>}' https://invoca.net/api/@@SIGNAL_API_VERSION/transactions.json
599592
curl -k -H "Content-Type: application/json" -X POST -d '{"search": {"transaction_id": "00000000-00000001"},"signals": [{"name": "Quality Call","value": "true"}], "custom_data": [{"name": "channel", "value": "Paid Search"}],"oauth_token": <YOUR OAUTH TOKEN>}' https://invoca.net/api/@@SIGNAL_API_VERSION/transactions.json
600593
curl -k -H "Content-Type: application/json" -X POST -d '{"search": {"transaction_id": "00000000-00000001"},"signals": [{"name": "Appointment Made","partner_unique_id": "1","occurred_at_time": "1440607313","value": "false"}], "custom_data": [{"name": "channel", "value": "Paid Search"}],"oauth_token": <YOUR OAUTH TOKEN>}' https://invoca.net/api/@@SIGNAL_API_VERSION/transactions.json
601-
602-
Migration Notes
603-
-------------------------------
604-
**Note**: If using the Signal Transactions Rollup feature (see section *Signal Transactions Rollup* above), this section can be ignored.
605-
606-
For upgrading from version ``2017-02-01``
607-
608-
* URL path was changed
609-
* Added **custom_data** key, an array of objects for setting custom data values
610-
* **signal** key was changed to **signals**, which is now an array of the same objects with the following changes
611-
612-
* Removed support for **custom_parameter_1**, **custom_parameter_2**, **custom_parameter_3** (use new **custom_data** outer key instead)
613-
* Removed support for **sale_amount** (use **revenue** instead)
614-
* Removed support for **description** (recommended to use Custom Data Fields instead)

0 commit comments

Comments
 (0)